openapi: 3.2.0
info:
  title: Mist Orgs Stats - VPN Peers API
  description: '> Version: **2607.1.1**

    >

    > Date: **August 17, 2026**


    NOTE:

    Some important API changes will be introduced.'
  contact:
    name: Thomas Munzer
    email: tmunzer@juniper.net
  version: 2607.1.1
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: {}
security:
- apiToken: []
- csrfToken: []
tags:
- name: Orgs Stats - VPN Peers
  description: API Calls to retrieve statistics about the VPN Peers (WAN Assurance)
paths:
  /api/v1/orgs/{org_id}/stats/vpn_peers/count:
    parameters: []
    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
  /api/v1/orgs/{org_id}/stats/vpn_peers/search:
    parameters: []
    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
components:
  schemas:
    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
    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
    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_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
    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
    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_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_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
    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
  securitySchemes:
    apiToken:
      type: apiKey
      description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n  `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed."
      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