Upgrades

URL:
https://<root>/system/upgrades
Methods:
POST
Required Capability:
Access allowed with either "Security and infrastructure" or "Servers" privileges
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.

Request parameters

ParameterDetails

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:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/system/upgrades?f=pjson

JSON 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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
{
  "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
      }
    ]
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.