OrgsLicenses
claimOrgLicense
Synchronously claims licenses and/or inventory devices from an activation code. All inventory devices are claimed immediately during the request.
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
Request to claim organization licenses or activation codes
code*string
Activation or license claim code to redeem
device_type?device_type_default_ap
If only intended to claim a certain device type, specify it here. enum: ap, gateway, switch.
Default
"ap"Value in
- "ap"
- "gateway"
- "switch"
type*claim_type
Claim scope, such as all, inventory, or license
Default
"all"Value in
- "all"
- "inventory"
- "license"
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/claim" \ -H "Content-Type: application/json" \ -d '{ "code": "ZHT3K-H36DT-MG85D-M61AC", "type": "all" }'{ "inventory_added": [ { "mac": "5c5b35000018", "magic": "6JG8EPTFV2A9Z2N", "model": "AP41", "serial": "FXLH2015150025", "type": "ap" } ], "inventory_duplicated": [ { "mac": "5c5b35000012", "magic": "DVH4VSNMSZPDXBR", "model": "AP41", "serial": "FXLH2015150027", "type": "ap" } ], "inventory_pending": [ { "mac": "5c5b35000012" } ], "license_added": [ { "end": 1520380800, "quantity": 180, "start": 1504828800, "type": "SUB-MAN" }, { "end": 1520380800, "quantity": 120, "start": 1504828800, "type": "SUB-LOC" } ], "license_duplicated": [ { "end": 1520380800, "quantity": 180, "start": 1504828800, "type": "SUB-MAN" } ], "license_error": [ { "order": "00000464", "reason": "" } ]}