Installer
claimInstallerDevices
Claim devices into the organization inventory by activation code through the installer workflow.
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
Format
uuidRequest Body
application/json
Request Body
List of Claim Codes
[index: integer]?string
Claim code
Response Body
curl -X POST "https://example.com/api/v1/installer/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices" \ -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))" ]}listInstallerListOfRecentlyClaimedDevices GET
Return recently claimed devices visible to installer workflows, with optional filters for model, site name, or site identifier.
createInstallerMap POST
Define a map or floorplan for an installer-managed site, including metadata used for AP placement and site visualization.