- URL:
- https://<root>/orgs/<orgID>/license/importLicense
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The import operation applies an ArcGIS Enterprise on Kubernetes license file (.json), which contains the ArcGIS Enterprise portal's user type and add-on licenses and capabilities, to an organization.
Request parameters
| Parameter | Details |
|---|---|
(Required) | For deployments using ArcGIS Enterprise on Kubernetes 10.9.1 or earlier, this file is an ArcGIS Enterprise portal license file. For deployments using ArcGIS Enterprise on Kubernetes 11.0 or later, this is an ArcGIS Enterprise on Kubernetes license file. |
| The response format. The default response is Values: |
Example usage
The following is a sample POST request for the import operation:
POST /<context>/admin/orgs/0123456789ABCDEF/licenses/importLicense HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=------boundary
------boundary
Content-Disposition: form-data; name="file"; filename="licenseFile.json"
Content-Type: application/octet-stream
kubernetesLicenseFile.json
------boundary
Content-Disposition: form-data; name="f"
pjson
------boundary
Content-Disposition: form-data; name="token"
Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis
------boundary--JSON Response example
{"status": "success"}