OrgsInventory

updateOrgInventoryAssignment

PUT
/api/v1/orgs/{org_id}/inventory

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.

Authorization

Authorization<token>

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

org_id*string
Formatuuid

Request Body

application/json

Request to assign, unassign, delete, or change management mode for inventory devices

disable_auto_config?boolean
Deprecated

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.

Defaultfalse
macs?array<string>

Device MAC addresses affected by this inventory operation

managed?boolean
Deprecated

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.

Defaultfalse
mist_configured?boolean

Whether the device can be configured by Mist. Replaces managed for adopted devices and disable_auto_config for claimed devices

no_reassign?boolean

If op==assign, if true, treat site assignment against an already assigned AP as error

Defaultfalse
op*inventory_update_operation

Inventory operation to apply to the listed devices. enum: assign, delete, downgrade_to_jsi, unassign, upgrade_to_mist.

Value in

  • "assign"
  • "delete"
  • "downgrade_to_jsi"
  • "unassign"
  • "upgrade_to_mist"
serials?array<string>

Device serial numbers affected by this inventory operation

site_id?string

If op==assign, target site ID for the inventory operation

Formatuuid

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/inventory" \  -H "Content-Type: application/json" \  -d '{    "disable_auto_config": false,    "macs": [      "5c5b350e0001"    ],    "no_reassign": false,    "op": "assign",    "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b"  }'

{  "error": [],  "op": "assign",  "reason": [],  "success": [    "5c5b350e0001"  ]}