Mist API Reference

https://www.juniper.net/documentation/us/en/software/mist/api/http/
Admin
The Mist API Reference provides comprehensive documentation for developers to programmatically...
Tokens:858,932
Snippets:4,596
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Example JSON Response for Installer Item

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/installers-item

This JSON object represents a typical response for an installer item in the Mist API. It includes standard fields like 'id' and 'name', along with an example of how additional properties can be included.

```json
{
  "id": "53f10664-3ce8-4c27-b382-0ef66432349f",
  "name": "Entry #1",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Get Site Gateway Metrics Response Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/get-site-gateway-metrics

Example of a successful response (200 OK) for the Get Site Gateway Metrics endpoint. It includes details like configuration success rate and version compliance scores for gateways.

```JSON
{
  "config_success": 99.9,
  "version_compliance": {
    "major_version": {
      "SRX320": {
        "major_count": 0,
        "major_version": "19.4R2-S1.2"
      }
    },
    "score": 99.9,
    "type": "gateway"
  }
}
```

--------------------------------

### Mist API HTTP Request Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/api-requests/http-headers

An example of an HTTP GET request to the Mist API, demonstrating the inclusion of necessary headers like Host, Content-Type, Accept, Authorization, and X-CSRFToken.

```http
GET /api/v1/sites HTTP/1.1
Host: api.mist.com
Content-Type: application/json
Accept: application/json, application/vnd.api+json
Authorization: Token {your_api_token}
X-CSRFToken: {csrftoken_value_from_cookie}  # Only if using login/password
```

--------------------------------

### Mist API HTTP Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-events-other-devices-search

This JSON object demonstrates a typical response from the Mist API. It includes pagination details like 'end', 'limit', 'start', and 'total', along with a 'results' object containing device or event-specific information. The example also shows how additional custom properties can be included.

```json
{
  "end": 206,
  "limit": 220,
  "results": {
    "device_mac": "device_mac0",
    "mac": "mac0",
    "org_id": "00002492-0000-0000-0000-000000000000",
    "site_id": "00001420-0000-0000-0000-000000000000",
    "text": "text4",
    "exampleAdditionalProperty": {
      "key1": "val1",
      "key2": "val2"
    }
  },
  "start": 164,
  "total": 58,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Example HTTP Response for Upgrade Org Devices Upgrade Info

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/upgrade-org-devices-upgrade-info

This JSON object represents a typical HTTP response for an API call related to upgrading organization devices. It includes details such as the upgrade ID, start time, status, and target device information, along with additional properties.

```json
{
  "id": "53f10664-3ce8-4c27-b382-0ef66432349f",
  "start_time": 1717658765,
  "status": "queued",
  "targets": {
    "download_requested": [
      "download_requested6"
    ],
    "downloaded": [
      "downloaded0",
      "downloaded1",
      "downloaded2"
    ],
    "downloading": [
      "downloading6"
    ],
    "failed": [
      "failed6"
    ],
    "reboot_in_progress": [
      "reboot_in_progress3",
      "reboot_in_progress4"
    ],
    "exampleAdditionalProperty": {
      "key1": "val1",
      "key2": "val2"
    }
  },
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Get Site Gateway Metrics cURL Request Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/get-site-gateway-metrics

An example of how to call the Get Site Gateway Metrics API endpoint using cURL. This demonstrates the necessary HTTP method, URL, and headers for making the request.

```Shell
curl -X GET \
  --url 'https://api.mist.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/gateways/metrics'  \
  -H 'Accept: application/json, application/vnd.api+json'
```

--------------------------------

### Device Upgrade Configuration Example (HTTP)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/upgrade-site-devices

An example JSON payload for configuring a device upgrade using the Juniper Mist API. It specifies parameters like strategy, version, device selection rules, and scheduling.

```json
{
  "canary_phases": null,
  "force": false,
  "max_failure_percentage": 5,
  "p2p_cluster_size": 0,
  "reboot": false,
  "reboot_at": 1624399840,
  "rrm_first_batch_percentage": 2,
  "rrm_max_batch_percentage": 10,
  "rrm_mesh_upgrade": "sequential",
  "rrm_node_order": "fringe_to_center",
  "rules": [
    {
      "match_model": "AP43",
      "match_name[2:8]": "access"
    },
    {
      "match_model": "AP45"
    }
  ],
  "snapshot": false,
  "start_time": 1624399840,
  "strategy": "big_bang",
  "version": "3.1.5",
  "device_ids": [
    "000019b7-0000-0000-0000-000000000000"
  ],
  "enable_p2p": false,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Basic Authentication Example (curl)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started

Provides an example of how to use HTTP Basic Authentication with the Mist API. It shows how to pass username and password, which are then base64-encoded and sent in the Authorization header. The 'Accept' header is also included.

```shell
curl {BASEURI} -u '{USERNAME}:{PASSWORD}' \
  -H 'Accept: application/json, application/vnd.api+json'
```

--------------------------------

### Example Configuration Properties in JSON

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/evpn-topology

This JSON snippet demonstrates the structure for 'exampleAdditionalProperty', which can be used to include custom key-value pairs within various API objects. It shows its presence within network configurations and EVPN options.

```json
{
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API Environments

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started

The Mist API is available across multiple global and regional environments. Choose the appropriate base URI based on your location or deployment.

```APIDOC
## Mist API Environments

The Mist API supports the following environments. The default environment is **Mist Global 01**.

### Mist Global Environments

- **Mist Global 01**: `https://api.mist.com`
- **Mist Global 02**: `https://api.gc1.mist.com`
- **Mist Global 03**: `https://api.ac2.mist.com`
- **Mist Global 04**: `https://api.gc2.mist.com`
- **Mist Global 05**: `https://api.gc4.mist.com`

### Mist EMEA Environments

- **Mist EMEA 01**: `https://api.eu.mist.com`
- **Mist EMEA 02**: `https://api.gc3.mist.com`
- **Mist EMEA 03**: `https://api.ac6.mist.com`
- **Mist EMEA 04**: `https://api.gc6.mist.com`

### Mist APAC Environments

- **Mist APAC 01**: `https://api.ac5.mist.com`
- **Mist APAC 02**: `https://api.gc5.mist.com`
- **Mist APAC 03**: `https://api.gc7.mist.com`

**Note**: The default server for all environments is **API Host**.
```

--------------------------------

### Mist API Stats Gateway Service Status JSON Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-gateway-service-status

This JSON object represents an example payload for the Stats Gateway Service Status in the Mist API. It includes various fields related to application installation and status, as well as an example of an additional property that can be included.

```json
{
  "appid_install_result": "appid_install_result6",
  "appid_install_timestamp": "appid_install_timestamp2",
  "appid_status": "appid_status2",
  "appid_version": 106,
  "ewf_status": "ewf_status6",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Example JSON Request for Response Device Config Cmd

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-device-config-cmd

This JSON object demonstrates the structure for sending a command to a device via the Mist API. It includes a required 'cmd' field and an optional 'exampleAdditionalProperty' for extra key-value pairs.

```json
{
  "cmd": "cmd8",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API HTTP Response Troubleshoot Model Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-troubleshoot

An example JSON payload illustrating the structure of an HTTP response for troubleshooting in the Mist API. It includes fields like 'end', 'start', and 'results', with nested objects and arrays.

```json
{
  "end": 1655151856,
  "start": 1655065456,
  "results": [
    {
      "category": "category4",
      "reason": "reason8",
      "recommendation": "recommendation8",
      "text": "text4",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### API Token Authentication Raw HTTP Request

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started

Illustrates the raw HTTP request format for API token authentication. This shows the essential headers required, including Host, Authorization, and Accept, for making a GET request to the API.

```http
GET / HTTP/1.1
Host: {HOST}
Authorization: {AUTHORIZATION}
Accept: application/json, application/vnd.api+json
```

--------------------------------

### Mist API HTTP Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-location-coverage

This snippet demonstrates a typical JSON response structure from the Mist API. It includes fields like 'beams_means', 'end', 'gridsize', 'result_def', 'results', and 'start', along with an example of an additional property.

```json
{
  "beams_means": [
    [
      153.16,
      153.17
    ],
    [
      153.16,
      153.17
    ]
  ],
  "end": 148,
  "gridsize": 202.46,
  "result_def": [
    "result_def4"
  ],
  "results": [
    [
      31.85,
      31.84
    ],
    [
      31.85,
      31.84
    ]
  ],
  "start": 106,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API HTTP Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-events-path-search

This JSON object represents a typical response from the Mist API for a path search. It includes pagination details (start, end, limit, total), a list of results, and an example of additional properties that can be included.

```json
{
  "end": 1697096379,
  "limit": 10,
  "start": 1697009979,
  "total": 2,
  "results": [
    {
      "mac": "mac0",
      "model": "model4",
      "org_id": "00002492-0000-0000-0000-000000000000",
      "policy": "policy8",
      "port_id": "port_id6",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    },
    {
      "mac": "mac0",
      "model": "model4",
      "org_id": "00002492-0000-0000-0000-000000000000",
      "policy": "policy8",
      "port_id": "port_id6",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    },
    {
      "mac": "mac0",
      "model": "model4",
      "org_id": "00002492-0000-0000-0000-000000000000",
      "policy": "policy8",
      "port_id": "port_id6",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### API Example: Additional Configuration Commands

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-setting

This snippet shows an array of strings representing additional configuration commands that can be applied via the Mist API. These are typically used for custom or advanced settings.

```json
[
  "additional_config_cmds0",
  "additional_config_cmds1",
  "additional_config_cmds2"
]
```

--------------------------------

### Mist API Stats Switch Vc Setup Info JSON Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-switch-vc-setup-info

This JSON object represents the structure for 'Stats Switch Vc Setup Info' in the Mist API. It includes fields like config_type, current_stats, request_type, and other relevant statistics. Additional properties can also be included.

```json
{
  "config_type": "nonprovisioned",
  "current_stats": "VCSETUP_WAITING",
  "request_type": "vc_create",
  "err_missing_dev_id_fpc": false,
  "last_update": 184.52,
  "request_time": 38.16,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Example Switch Port Configuration JSON

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/junos-local-port-config

This JSON snippet demonstrates a typical configuration for a switch port using the Mist API. It includes settings for network assignments, MAC authentication, port speed, and operational notes.

```json
{
  "all_networks": false,
  "allow_multiple_supplicants": false,
  "bypass_auth_when_server_down": false,
  "bypass_auth_when_server_down_for_unknown_client": false,
  "disable_autoneg": false,
  "disabled": false,
  "duplex": "auto",
  "dynamic_vlan_networks": [
    "corp",
    "user"
  ],
  "enable_mac_auth": false,
  "enable_qos": false,
  "inter_switch_link": false,
  "mac_auth_protocol": "eap-md5",
  "mac_limit": 0,
  "note": "force 100M for camera",
  "persist_mac": false,
  "poe_disabled": false,
  "speed": "auto",
  "stp_edge": false,
  "stp_no_root_port": false,
  "stp_p2p": false,
  "usage": "usage8"
}
```

--------------------------------

### Mist API HTTP Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-client-events-search

This snippet demonstrates the structure of a typical HTTP response from the Mist API for client events search. It includes common fields like 'end', 'limit', 'results', 'start', and 'total', along with an example of nested data structures and additional properties.

```json
{
  "end": 20,
  "limit": 150,
  "results": [
    {
      "band": "6",
      "key_mgmt": "WPA2-PSK",
      "proto": "b",
      "timestamp": 2.64,
      "ap": "ap8",
      "bssid": "bssid0",
      "channel": 30,
      "ssid": "ssid6",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "start": 234,
  "total": 244,
  "next": "next4",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Example HTTP JSON Configuration

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/gateway-port-config

This JSON object demonstrates a sample configuration for an HTTP request, showcasing various port and network settings available through the Juniper Mist API. It includes options for aggregated Ethernet, WAN types, and advanced features.

```json
{
  "ae_disable_lacp": false,
  "ae_lacp_force_up": false,
  "aggregated": false,
  "critical": false,
  "disable_autoneg": false,
  "disabled": false,
  "dsl_type": "vdsl",
  "dsl_vci": 35,
  "dsl_vpi": 0,
  "duplex": "full",
  "lte_auth": "none",
  "poe_disabled": false,
  "preserve_dscp": true,
  "reth_nodes": [
    "node0",
    "node1"
  ],
  "speed": "1g",
  "ssr_no_virtual_mac": false,
  "svr_port_range": "60000-60005",
  "usage": "lan",
  "wan_arp_policer": "default",
  "wan_disable_speedtest": false,
  "wan_ext_ip": "64.2.4.3",
  "wan_ext_ip6": "2601:1700:43c0:dc0::10",
  "wan_type": "broadband",
  "ae_idx": "ae_idx6",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Psk Portal Sso Model Example - JSON

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/psk-portal-sso

This JSON object demonstrates the structure and fields required for configuring the Psk Portal Sso model. It includes example values for various parameters such as identity provider signing algorithm, allowed roles, certificates, SSO URL, issuer, and an example of additional properties.

```json
{
  "idp_sign_algo": "sha256",
  "allowed_roles": [
    "allowed_roles7"
  ],
  "idp_cert": "idp_cert2",
  "idp_sso_url": "idp_sso_url8",
  "issuer": "issuer8",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API Device Metrics Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-device-metrics

This is an example JSON response for the Mist API's Device Metrics endpoint. It demonstrates the structure and data types for fields such as end, interval, results, rt, and start. This model can also accept additional properties of type Object.

```json
{
  "end": 172,
  "interval": 82,
  "results": [
    "String0",
    "String1"
  ],
  "rt": [
    "rt4",
    "rt5"
  ],
  "start": 130,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Site Configuration

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-setting-derived

Manages site configurations including device settings, routing, and variable definitions.

```APIDOC
## PUT /api/v1/sites/{site_id}

### Description
Updates the configuration for a specific site, allowing modification of various settings such as device thresholds, routing rules, and custom variables.

### Method
PUT

### Endpoint
`/api/v1/sites/{site_id}`

### Parameters
#### Path Parameters
- **site_id** (string) - Required - The ID of the site to update.

#### Query Parameters
None

#### Request Body
- **ap_updown_threshold** (integer) - Optional - Threshold for AP up/down events.
- **auto_upgrade_linecard** (boolean) - Optional - Enables automatic line card upgrades.
- **blacklist_url** (string) - Optional - URL for the blacklist.
- **config_auto_revert** (boolean) - Optional - Enables automatic configuration reversion.
- **default_port_usage** (string) - Optional - Default port usage setting.
- **device_updown_threshold** (integer) - Optional - Threshold for device up/down events.
- **enable_unii_4** (boolean) - Optional - Enables UNII-4.
- **extra_routes** (object) - Optional - Defines extra IPv4 routes.
- **extra_routes6** (object) - Optional - Defines extra IPv6 routes.
- **gateway_updown_threshold** (integer) - Optional - Threshold for gateway up/down events.
- **persist_config_on_device** (boolean) - Optional - Persists configuration on the device.
- **remove_existing_configs** (boolean) - Optional - Removes existing configurations.
- **report_gatt** (boolean) - Optional - Enables GATT reporting.
- **site_id** (string) - Optional - The ID of the site.
- **switch_updown_threshold** (integer) - Optional - Threshold for switch up/down events.
- **track_anonymous_devices** (boolean) - Optional - Tracks anonymous devices.
- **tunterm_monitoring_disabled** (boolean) - Optional - Disables tunnel termination monitoring.
- **vars** (object) - Optional - Custom variables for the site.
- **vrf_instances** (object) - Optional - VRF instances configuration.
- **watched_station_url** (string) - Optional - URL for watched stations.
- **whitelist_url** (string) - Optional - URL for the whitelist.
- **account_id** (string) - Optional - The account ID.
- **auto_probe_subnet** (string) - Optional - Subnet for auto probing.
- **cloud_name** (string) - Optional - The cloud name.
- **company** (string) - Optional - The company name.
- **enable_probe** (boolean) - Optional - Enables probing.
- **acl_policies** (array) - Optional - List of ACL policies.
- **acl_tags** (object) - Optional - ACL tags configuration.

### Request Example
```json
{
  "ap_updown_threshold": 0,
  "auto_upgrade_linecard": true,
  "blacklist_url": "https://papi.s3.amazonaws.com/blacklist/xxx...",
  "config_auto_revert": false,
  "default_port_usage": "default",
  "device_updown_threshold": 0,
  "enable_unii_4": false,
  "extra_routes": {
    "0.0.0.0/0": {
      "via": "192.168.1.10"
    }
  },
  "extra_routes6": {
    "2a02:1234:420a:10c9::/64": {
      "via": "2a02:1234:200a::100"
    }
  },
  "gateway_updown_threshold": 0,
  "persist_config_on_device": false,
  "remove_existing_configs": false,
  "report_gatt": false,
  "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6",
  "switch_updown_threshold": 0,
  "track_anonymous_devices": false,
  "tunterm_monitoring_disabled": false,
  "vars": {
    "RADIUS_IP1": "172.31.2.5",
    "RADIUS_SECRET": "11s64632d"
  },
  "vrf_instances": {
    "guest": {
      "extra_routes": {
        "0.0.0.0/0": {
          "via": "192.168.31.1"
        }
      },
      "networks": [
        "guest"
      ]
    }
  },
  "watched_station_url": "https://papi.s3.amazonaws.com/watched_station/xxx...",
  "whitelist_url": "https://papi.s3.amazonaws.com/whitelist/xxx...",
  "account_id": "iojzXIJWEuiD73ZvydOfg",
  "auto_probe_subnet": "11.0.0.0/8",
  "cloud_name": "Tapi.sase.paloaltonetworks.com",
  "company": "Test Company1 Ltd",
  "enable_probe": false,
  "acl_policies": [
    {
      "actions": [
        {
          "action": "allow",
          "dst_tag": "dst_tag0"
        }
      ],
      "name": "name2",
      "src_tags": [
        "src_tags1",
        "src_tags0"
      ]
    }
  ],
  "acl_tags": {
    "key0": {
      "ether_types": [
        "ether_types8",
        "ether_types9"
      ],
      "gbp_tag": 14,
      "macs": [
        "macs1"
      ],
      "network": "network2",
      "port_usage": "port_usage0",
      "type": "network"
    }
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the site.
- **org_id** (string) - The organization ID.
- **site_id** (string) - The site ID.
- **error** (string) - Error message if the operation failed.
- **errors** (array of strings) - A list of errors encountered.
- **last_status** (string) - The last status of the site configuration update.
- **last_sync** (integer) - Timestamp of the last synchronization.
- **linked_by** (string) - The user who linked the account.
- **linked_timestamp** (integer) - Timestamp when the account was linked.
- **max_daily_api_requests** (integer) - Maximum daily API requests allowed.
- **name** (string) - The name of the site or company.
- **region** (string) - The region of the site.

#### Response Example
```json
{
  "id": "53f10664-3ce8-4c27-b382-0ef66432349f",
  "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61",
  "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6",
  "error": null,
  "errors": [],
  "last_status": "success",
  "last_sync": 1665465339000,
  "linked_by": "Testname1",
  "linked_timestamp": 1665465339000,
  "max_daily_api_requests": 5000,
  "name": "Test Compay1 Ltd",
  "region": "americas"
}
```
```

--------------------------------

### Mist API: Response Auto Orientation Info JSON Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-auto-orientation-info

This JSON object represents the 'Response Auto Orientation Info' model, detailing the status and timing of an auto-orientation process for a map. It includes fields like estimated time left, start time, status, and stop time, along with an example of additional properties.

```json
{
  "est_time_left": 122.9,
  "start_time": 151.7,
  "status": "done",
  "stop_time": 157.08,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API Sle Impact Summary JSON Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sle-impact-summary

This JSON object represents the structure for the Sle Impact Summary in the Mist API. It includes fields for access points, band, classifier, device OS, device type, end time, failure, metric, start time, and WLAN, along with example data and additional properties.

```json
{
  "ap": [
    {
      "ap_mac": "ap_mac6",
      "degraded": 149.14,
      "duration": 22.2,
      "name": "name4",
      "total": 78.86,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "band": [
    {
      "band": "band4",
      "degraded": 250.12,
      "duration": 123.18,
      "name": "name2",
      "total": 22.12,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "classifier": "classifier4",
  "device_os": [
    {
      "degraded": 94.1,
      "device_os": "device_os0",
      "duration": 223.16,
      "name": "name0",
      "total": 122.1,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "device_type": [
    {
      "degraded": 131.9,
      "device_type": "device_type0",
      "duration": 4.96,
      "name": "name0",
      "total": 159.9,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "end": 186.58,
  "failure": "failure4",
  "metric": "metric8",
  "start": 142.64,
  "wlan": [
    {
      "degraded": 169.9,
      "duration": 42.96,
      "name": "name0",
      "total": 197.9,
      "wlan_id": "wlan_id2",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API Configuration Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/mxcluster

An example of a JSON object representing a Mist API configuration, showcasing various settings for network management, dynamic authorization, and NAC.

```json
{
  "id": "53f10664-3ce8-4c27-b382-0ef66432349f",
  "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61",
  "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6",
  "tunterm_hosts_selection": "shuffle",
  "created_time": 209.42,
  "for_site": false,
  "mist_das": {
    "coa_servers": [
      {
        "disable_event_timestamp_check": false,
        "enabled": false,
        "host": "host8",
        "port": 28,
        "require_message_authenticator": false,
        "exampleAdditionalProperty": {
          "key1": "val1",
          "key2": "val2"
        }
      },
      {
        "disable_event_timestamp_check": false,
        "enabled": false,
        "host": "host8",
        "port": 28,
        "require_message_authenticator": false,
        "exampleAdditionalProperty": {
          "key1": "val1",
          "key2": "val2"
        }
      }
    ],
    "enabled": false,
    "exampleAdditionalProperty": {
      "key1": "val1",
      "key2": "val2"
    }
  },
  "mist_nac": {
    "acct_server_port": 70,
    "auth_server_port": 34,
    "client_ips": {
      "key0": {
        "require_message_authenticator": false,
        "secret": "secret4",
        "site_id": "0000197c-0000-0000-0000-000000000000",
        "vendor": "cisco-aironet",
        "exampleAdditionalProperty": {
          "key1": "val1",
          "key2": "val2"
        }
      },
      "key1": {
        "require_message_authenticator": false,
        "secret": "secret4",
        "site_id": "0000197c-0000-0000-0000-000000000000",
        "vendor": "cisco-aironet",
        "exampleAdditionalProperty": {
          "key1": "val1",
          "key2": "val2"
        }
      },
      "key2": {
        "require_message_authenticator": false,
        "secret": "secret4",
        "site_id": "0000197c-0000-0000-0000-000000000000",
        "vendor": "cisco-aironet",
        "exampleAdditionalProperty": {
          "key1": "val1",
          "key2": "val2"
        }
      }
    },
    "enabled": false,
    "secret": "secret6",
    "exampleAdditionalProperty": {
      "key1": "val1",
      "key2": "val2"
    }
  },
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API Response: Insight Rogue Client JSON Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-insight-rogue-client

An example JSON payload representing the 'Insight Rogue Client' model from the Mist API. This structure is used for retrieving client insights and includes fields like 'end', 'limit', 'results', and 'start'. The 'results' field is an array of client objects, each potentially containing additional properties.

```json
{
  "end": 226,
  "limit": 200,
  "results": [
    {
      "annotation": "annotation0",
      "ap_mac": "ap_mac8",
      "avg_rssi": 170.84,
      "band": "band8",
      "bssid": "bssid0",
      "client_mac": "client_mac4",
      "num_aps": 140,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "start": 184,
  "next": "next2",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Site Setting Juniper Srx Gateway Model Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-setting-juniper-srx-gateway

This JSON object represents the structure for configuring site settings for a Juniper SRX Gateway via the Mist API. It includes essential API credentials and an example of how to include additional, arbitrary properties.

```json
{
  "api_key": "5abf7c8a-1a1c-4398-ba2d-b0c297094d1a",
  "api_password": "abc@123",
  "api_url": "https://23.43.12.78:8443",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API Site Occupancy Analytics Configuration Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-occupancy-analytics

This JSON object demonstrates the configuration for Site Occupancy Analytics in the Mist API. It shows how to enable or disable client and asset tracking, set a minimum duration for occupancy detection, and includes an example of an additional, custom property.

```json
{
  "assets_enabled": false,
  "clients_enabled": true,
  "min_duration": 3000,
  "sdkclients_enabled": false,
  "unconnected_clients_enabled": false,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API HTTP Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-events-rogue-search

This snippet shows an example JSON response structure for an HTTP request to the Mist API, likely for searching events or rogue devices. It includes fields like 'end', 'limit', 'results', 'start', 'total', and 'next', along with nested structures for 'ap', 'bssid', 'channel', 'rssi', 'ssid', 'timestamp', and additional properties.

```json
{
  "end": 112,
  "limit": 58,
  "results": [
    {
      "ap": "ap8",
      "bssid": "bssid0",
      "channel": 30,
      "rssi": 68,
      "ssid": "ssid6",
      "timestamp": 2.64,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "start": 70,
  "total": 152,
  "next": "next2",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Site Stats Response JSON

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/get-site-stats

This is an example JSON response for the 'Get Site Stats' API endpoint. It contains various statistics about a site, including address, creation time, network details, and counts of connected devices.

```json
{
  "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
}
```

--------------------------------

### Mist API Org Devices HTTP Response Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-org-devices

This is an example of an HTTP response from the Mist API for retrieving organization devices. It shows the structure of the 'results' array, containing individual device objects with properties like 'mac', 'name', and an 'exampleAdditionalProperty'. The response also includes top-level 'exampleAdditionalProperty'.

```json
{
  "results": [
    {
      "mac": "mac0",
      "name": "name6",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Sle Histogram Data Structure Example (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sle-histogram

This snippet demonstrates the expected JSON structure for a Sle Histogram, including required fields like 'data', 'end', 'metric', 'start', 'x_label', and 'y_label'. It also shows optional additional properties.

```json
{
  "data": [
    {
      "range": [
        7.03,
        7.04
      ],
      "value": 95.62,
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "end": 37.86,
  "metric": "metric0",
  "start": 249.92,
  "x_label": "x_label6",
  "y_label": "y_label6",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API: Response Async License Detail JSON Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-async-license-detail

This JSON object represents an example response for the Async License Detail API endpoint. It includes device MAC address, status, and timestamp, along with an example of how additional properties can be included.

```json
{
  "mac": "mac0",
  "status": "status8",
  "timestamp": 238.64,
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Mist API HTTP Response Structure Example

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-events-search

This JSON object illustrates the structure of a typical HTTP response from the Mist API for event searches. It includes fields like 'end', 'limit', 'results', 'start', and 'total', along with nested objects and arrays.

```json
{
  "end": 36,
  "limit": 134,
  "results": [
    {
      "band": "6",
      "key_mgmt": "WPA2-PSK",
      "proto": "b",
      "timestamp": 2.64,
      "ap": "ap8",
      "bssid": "bssid0",
      "channel": 30,
      "ssid": "ssid6",
      "exampleAdditionalProperty": {
        "key1": "val1",
        "key2": "val2"
      }
    }
  ],
  "start": 250,
  "total": 28,
  "next": "next0",
  "exampleAdditionalProperty": {
    "key1": "val1",
    "key2": "val2"
  }
}
```

--------------------------------

### Switch Site Settings

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-setting-derived

Configure general switch settings for a site.

```APIDOC
## POST /api/v1/sites/{site_id}/settings

### Description
Configures general switch settings for a specific site.

### Method
POST

### Endpoint
`/api/v1/sites/{site_id}/settings`

### Parameters
#### Path Parameters
- **site_id** (UUID) - Required - The ID of the site to configure.

#### Request Body
- **switch** (Site Setting Switch) - Optional - General switch site settings.
```
Tokens:
Raw