How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist Orgs Inventory API

The Org Inventory allows administrators to view and manage all devices registered (claimed) to the Organization.

Mist Orgs Inventory API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs Inventory. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 7 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 2606.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

9 operations 7 paths 49 schemas 3 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Orgs Inventory API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs Inventory 9

The Org Inventory allows administrators to view and manage all devices registered (claimed) to the Organization.

GET
/api/v1/orgs/{org_id}/inventory
getOrgInventory
getOrgInventory 13 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/inventory
addOrgInventory
addOrgInventory 1 param body → 200400401403404429
PUT
/api/v1/orgs/{org_id}/inventory
updateOrgInventoryAssignment
updateOrgInventoryAssignment 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/inventory/count
countOrgInventory
countOrgInventory 8 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/inventory/create_ha_cluster
createOrgGatewayHaCluster
createOrgGatewayHaCluster 1 param body → 200400401403404429
POST
/api/v1/orgs/{org_id}/inventory/delete_ha_cluster
deleteOrgGatewayHaCluster
deleteOrgGatewayHaCluster 1 param body → 200400401403404429
POST
/api/v1/orgs/{org_id}/inventory/reevaluate_auto_assignment
reevaluateOrgAutoAssignment
reevaluateOrgAutoAssignment 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/inventory/replace
replaceOrgDevices
replaceOrgDevices 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/inventory/search
searchOrgInventory
searchOrgInventory 15 params → 200400401403404429

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are inventory (22 properties), inventory_search_result (13 properties), inventory_update (8 properties), inventory_search (6 properties). Each schema is shown below with its type and property counts.

tunterm_port_config_upstream_port_vlan_id
Native VLAN ID for upstream ports
response_inventory_inventory_added
array
Detailed inventory records added by the claim operation
ha_cluster_config
object
Request to create an HA cluster from unassigned gateway inventory nodes
5 properties
replace_device_discard
array
Attributes that should not be copied to the replacement device
inventory_search_result_member
object
Virtual Chassis member in an inventory search result
3 properties
response_http403
object
Standard HTTP 403 permission error response
1 property
response_inventory_inventory_added_items
object
Inventory device added by the claim operation
5 properties 5 required
org_id
string
Unique identifier of a Mist organization
tunterm_port_config
object
Ethernet port configuration for tunnel termination interfaces
4 properties
response_http400
object
Standard HTTP 400 bad request error response
1 property
response_count
object
Distinct count response for time-bounded search results
6 properties 6 required
response_inventory_duplicated
array
Claim codes already present in organization inventory
ha_cluster_delete
object
Request body identifying the HA cluster node to remove
1 property
response_org_inventory_change
object
Result of an organization inventory assignment or deletion operation
4 properties 4 required
claim_codes
array
List of Claim Codes
response_inventory_inventory_duplicated
array
Detailed inventory records already present during the claim operation
inventory_count_distinct
string
enum: model, status, siteid, sku, version
strings
array
Unique string values returned or accepted by this schema
tunterm_port_config_downstream_ports
array
List of ports to be used for downstream (to AP) purpose
count_results
array
List of count result rows
tunterm_port_config_upstream_ports
array
List of ports to be used for upstream purpose (to LAN)
device_status_filter
string
Filter devices based on their status. enum: connected, disconnected
modified_time
number
When the object has been modified for the last time, in epoch
count_result
object
Count result row with the matching distinct field values
1 property 1 required
response_org_inventory_change_op
string
enum: assign, delete, downgradetojsi, unassign, upgradetomist
response_inventory
object
Result of adding device claim codes to organization inventory
6 properties
ha_cluster_config_nodes
array
Gateway inventory nodes used to create an HA cluster
response_http404
object
Standard HTTP 404 not found error response
1 property
response_inventory_error
array
Claim codes rejected by the inventory add operation
inventory_search_results
array
Inventory records returned by an inventory search
ha_cluster_config_node
object
HA cluster inventory node identified by MAC address
1 property
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
inventory_search
object
Paginated inventory search response
6 properties
inventory_update_macs
array
If op==assign, op==unassign, op==upgradetomist, or op==downgradetojsi, device MAC addresses to update
inventory_list
array
Inventory records for claimed devices
id
string
Unique ID of the object instance in the Mist Organization
inventory_search_result
object
Inventory record returned by inventory search
13 properties
site_id
string
Unique identifier of a Mist site
replace_device
object
Request payload for replacing an inventory device with a claimed, unassigned device
5 properties
created_time
number
When the object has been created, in epoch
response_inventory_added
array
Claim codes accepted into organization inventory
inventory
object
Organization inventory record for a claimed device
22 properties
response_inventory_inventory_duplicated_items
object
Inventory device already present during the claim operation
5 properties 5 required
inventory_update_operation
string
enum: upgradetomist: Upgrade to mist-managed downgradetojsi: Downgrade to basic monitoring. When downgrading a VC member to jsi, we will move the cloud connect…
inventory_update_serials
array
If op==delete, device serial numbers to delete from inventory
inventory_update
object
Request to assign, unassign, delete, or change management mode for inventory devices
8 properties 1 required
device_type_default_ap
string
enum: ap, gateway, switch
inventory_search_result_members
array
Virtual Chassis members included in an inventory search result

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-orgs-inventory-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Orgs Inventory API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.