- URL:
- https://<root>/system/upgrades/installed
- 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 installed operation returns a cumulative list of patches and releases that are installed in the deployment.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Response properties
| Properties | Details |
|---|---|
new | A binary property (true or false) specifying if the patch or release required new licenses. |
release | The release number of the update. |
description | An update description that outlines the changes applied to the deployment. |
update | The update type (release or patch). |
version | The version number of the deployment if the patch or release is applied. |
url | The address that represents the external link pointing to the detailed information about the patch. This link is not valid for release upgrades. |
previous | The previous build number of the update. |
release | The notes included with the update. |
build | The build number of the update. |
previous | The version number that the patch or release builds on. |
name | The name of the patch or release. |
containers | A JSON array that specifies the name, image, and checksum value of affected containers. |
id | The unique ID associated with each patch or release. |
released | The date of release of the patch or release, represented in milliseconds from epoch (Unix time). |
Example usage
The following is a sample POST request for the installed operation:
POST /<context>/admin/system/upgrades/installed HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response example
The response example below demonstrates a deployment with an installed patch:
{
"updates": [
{
"newLicensesRequired": false,
"releaseBuild": "1089",
"description": "",
"type": "patch",
"version": "10.9.0",
"url": "https://support.esri.com/download/7443",
"previousBuild": "1089",
"releaseNotes": "",
"build": "1090",
"previousVersion": "10.9.0",
"name": "Overview Patch for ArcGIS Enterprise",
"containers": [
{
"image": "enterprise-admin:dev-stable-1089",
"name": "ENTERPRISE_ADMIN_API",
"checksum": "d8203f62486387d4abeb2b32ab59e2541e79bd4b8cbaee2366219bacd2f207cb"
},
{
"image": "help:dev-stable-1089",
"name": "HELP",
"checksum": "d8203f62486387d4abeb2b32ab59e2541e79bd4b8cbaee2366219bacd2f207cb"
},
{
"image": "enterprise-admin-tools:dev-stable-1089",
"name": "ADMIN_TOOLS",
"checksum": "d8203f62486387d4abeb2b32ab59e2541e79bd4b8cbaee2366219bacd2f207cb"
},
{
"image": "arcgis-nginx-web:dev-stable-1089",
"name": "WEB_PROXY",
"checksum": "d8203f62486387d4abeb2b32ab59e2541e79bd4b8cbaee2366219bacd2f207cb"
}
],
"id": "pat_345432_1090",
"released": 1618540600000
}
]
}The following response demonstrates a deployment with no installed patch or release:
{"updates": []}