OrgsLicenses

createOrgAsyncClaim

POST
/api/v1/orgs/{org_id}/claims

Schedules an async claim for inventory devices. Inventory claiming is queued and processed in the background; the response returns immediately with a claim_id for polling. Licenses (if type=all) are still claimed synchronously during the request.

Use GET /api/v1/orgs/{org_id}/claims/{claim_id} to poll the result.

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 Body

Request to schedule an asynchronous inventory claim

code*string

Activation code to claim

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_async

Claim scope; all claims licenses synchronously and queues inventory, inventory queues inventory only

Value in

  • "all"
  • "inventory"

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/claims" \  -H "Content-Type: application/json" \  -d '{    "code": "ZHT3K-H36DT-MG85D-M61AC",    "type": "inventory"  }'
{  "claim_id": "8e2a0c6f-6f3c-4c4e-9c72-8c5b1c1b6b9b",  "inventory_pending": [    {      "mac": "5c5b35000012"    },    {      "mac": "5c5b35000018"    }  ]}