MspsLicenses

claimMspLicense

POST
/api/v1/msps/{msp_id}/claim

Claim a license order for this MSP by submitting the activation code from the order.

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

msp_id*string
Formatuuid

Request Body

application/json

Request body containing a single authorization or claim code

code*string

Request-supplied authorization or claim code value

Response Body

curl -X POST "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/claim" \  -H "Content-Type: application/json" \  -d '{    "code": "ZHT3K-H36DT-MG85D-M61AC"  }'
{  "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": ""    }  ]}