addOrgInventory
Claim devices into the organization inventory using order activation codes or device claim codes.
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.
In: header
Path Parameters
uuidRequest Body
application/json
Request Body
List of Claim Codes
Claim code
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/inventory" \ -H "Content-Type: application/json" \ -d '[ "6JG8E-PTFV2-A9Z2N", "DVH4V-SNMSZ-PDXBR" ]'{ "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))" ]}getOrgInventory GET
Get Org Inventory ### VC (Virtual-Chassis) Management Starting with the April release, Virtual Chassis devices in Mist will now use a cloud-assigned virtual MAC address as the device ID, instead of the physical MAC address of the FPC0 member. **Retrieving the device ID or Site ID of a Virtual Chassis:** 1. Use this API call with the query parameters `vc=true` and `mac` set to the MAC address of the VC member. 2. In the response, check the `vc_mac` and `mac` fields: - If `vc_mac` is empty or not present, the device is not part of a Virtual Chassis. The `device_id` and `site_id` will be available in the device information. - If `vc_mac` differs from the `mac` field, the device is part of a Virtual Chassis but is not the device used to generate the Virtual Chassis ID. Use the `vc_mac` value with the [Get Org Inventory](/api/mist/orgs/orgs-inventory/getOrgInventory) API call to retrieve the `device_id` and `site_id`. - 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 in the device information. 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.
updateOrgInventoryAssignment PUT
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.