- URL:https://<root>/system/upgrades(POST only)
- Operations:Check Available Updates, Upgrade, Check Installed Updates, Check Rollback Options, Rollback, Import Version Manifest, Get Upgrade Settings
- Child Resources:Current Version, History, Configurations
- Required Capability:Default administrator role | Security and infrastructure | Servers
- Version Introduced:10.9
Description
The upgrades resource provides access to child operations and resources that are used to manage the release and patch updates that can be applied to an ArcGIS Enterprise on Kubernetes deployment. During the upgrade process, this resource returns detailed, real-time messages regarding the status and progress of the upgrade. While an upgrade is in progress, child operations and resources for this resource will be inaccessible. Once completed, all child endpoints will be operational, and the JSON view of the resource will contain a log of the job messages and the completion status.
Note:
When the current version of the deployment is represented, the version and build number are combined. For example, if the deployment version is 10.9.0 and the build number is 505, the current version is returned as 10.9.0.505. The version number is updated with each installed release, and the build number is updated with each update (either patch or release) installed. This representation is returned through the HTML view of the API, as well as in the upgrade job messages retained by the currentVersion and upgrades resources. For an example of these messages, see the JSON Response examples section below.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default format is html. Values: html | json | pjson |
Example usage
The following is a sample request URL used to access the upgrades resource:
https://organization.domain.com/context/admin/system/upgrades?f=pjsonJSON Response examples
The response example below is returned when the base ArcGIS Enterprise on Kubernetes deployment has not had a patch or release upgrade installed:
{
"status": {
"code": 0,
"messages": [],
"state": "no_upgrade"
}
}The following is a sample JSON response that is returned when a patch upgrade has been successfully installed:
{
"status": {
"state": "success",
"code": 3,
"messages": [
{
"message": "Starting the upgrade process from 10.9.0.505 to 10.9.0.506.",
"when": 1602264532256,
"code": 2010
},
{
"message": "Patch upgrade of gis-ve0e34651-ad0a-4389-83b3-aec643491c1c-geometryserver started. ",
"when": 1602264546550,
"code": 2037
},
{
"message": "Updating deployment gis-ve0e34651-ad0a-4389-83b3-aec643491c1c-geometryserver with new image.",
"when": 1602264546550,
"code": 2038
},
{
"message": "Patch upgrade of gis-enterpriseadmin started. ",
"when": 1602264546739,
"code": 2037
},
{
"message": "Updating deployment gis-enterpriseadmin with new image.",
"when": 1602264546740,
"code": 2038
},
{
"message": "Patch upgrade of gis-v2c62c182-e8ca-4bec-8854-27af5b90f55c-mapserver started. ",
"when": 1602264546941,
"code": 2037
},
{
"message": "Updating deployment gis-v2c62c182-e8ca-4bec-8854-27af5b90f55c-mapserver with new image.",
"when": 1602264546942,
"code": 2038
},
{
"message": "Patch upgrade of gis-v6b24c34d-4228-422e-b118-523eb57f3413-mapserver started. ",
"when": 1602264547148,
"code": 2037
},
{
"message": "Updating deployment gis-v6b24c34d-4228-422e-b118-523eb57f3413-mapserver with new image.",
"when": 1602264547148,
"code": 2038
},
{
"message": "Patch upgrade of gis-ve0e34651-ad0a-4389-83b3-aec643491c1c-geometryserver completed.",
"when": 1602264576981,
"code": 2039
},
{
"message": "Patch upgrade of gis-portal-sharing-10-9-0-505 started. ",
"when": 1602264576982,
"code": 2037
},
{
"message": "Patch upgrade of gis-v53179588-a4d2-4a97-80fc-e6862db614c4-featureserver started. ",
"when": 1602264577025,
"code": 2037
},
{
"message": "Updating deployment gis-v53179588-a4d2-4a97-80fc-e6862db614c4-featureserver with new image.",
"when": 1602264577025,
"code": 2038
},
{
"message": "Updating deployment gis-portal-sharing-10-9-0-505 with new image.",
"when": 1602264577051,
"code": 2038
},
{
"message": "Updating deployment gis-portal-sharing-10-9-0-505 with new image.",
"when": 1602264577051,
"code": 2038
},
{
"message": "Patch upgrade of gis-v2c62c182-e8ca-4bec-8854-27af5b90f55c-mapserver completed.",
"when": 1602264577115,
"code": 2039
},
{
"message": "Patch upgrade of gis-v6b24c34d-4228-422e-b118-523eb57f3413-mapserver completed.",
"when": 1602264577296,
"code": 2039
},
{
"message": "Patch upgrade of gis-v53179588-a4d2-4a97-80fc-e6862db614c4-featureserver completed.",
"when": 1602264607217,
"code": 2039
},
{
"message": "Patch upgrade of gis-portal-sharing-10-9-0-505 completed.",
"when": 1602264607268,
"code": 2039
},
{
"message": "The patch upgrade of Computes module has completed in 60936 millis (~ 1 minutes).",
"when": 1602264607269,
"code": 1271
},
{
"message": "Patch upgrade of gis-portal-home-10-9-0-505 started. ",
"when": 1602264607639,
"code": 2037
},
{
"message": "Updating deployment gis-portal-home-10-9-0-505 with new image.",
"when": 1602264607639,
"code": 2038
},
{
"message": "Patch upgrade of gis-portal-home-10-9-0-505 completed.",
"when": 1602264637770,
"code": 2039
},
{
"message": "The patch upgrade of Apps module has completed in 30338 millis (~ 0 minutes).",
"when": 1602264637775,
"code": 1271
},
{
"message": "The upgrade process from 10.9.0.505 to 10.9.0.506 has completed in 00hr:01min:33sec:292millisec.",
"when": 1602264638272,
"code": 2011
},
{
"message": "The ArcGIS Enterprise on Kubernetes has been upgraded from 10.9.0.505 to 10.9.0.506 successfully.",
"when": 1602264638272,
"code": 2012
}
]
}
}