- URL:
- https://<root>/license/updateLicenseManager
- Methods:
POST- Version Introduced:
- 10.3
Access requirements
Required privileges
The Portal 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 Portal 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 Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The update operation changes the license server connection information for ArcGIS Enterprise portal. ArcGIS License Manager works with ArcGIS Enterprise portal and enforces licenses for ArcGIS Pro.
For highly available ArcGIS Enterprise portal environments, you can register a backup license manager. After configuring the backup license manager, ArcGIS Enterprise portal will automatically restart. When the restart completes, ArcGIS Enterprise portal is configured with the backup license server you specified. When configuring a backup license manager, you will need to ensure that the backup is authorized using the same license file as your Enterprise portal.
Request parameters
| Parameter | Details |
|---|---|
| The JSON representation of the license server connection information. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/portaladmin/license/updateLicenseManager HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
licenseManagerInfo={
"hostname": "licensemanager.example.com,backuplicensemanager.example.com",
"port": 27000
}&f=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 20
}