Get Upgrade Settings

URL:: https://<root>/system/upgrades/getUpgradeSettings
Methods:: POST
Required Capability:: Access allowed with either "Security and infrastructure" or "Servers" privileges
Version Introduced:: 11.0

Description

The getUpgradeSettings operation returns the required upgrade settings, and their expected formats, needed for a specific release, applicable to ArcGIS Enterprise on Kubernetes versions 11.0 and later. These settings must be passed through as values for the upgradeSettings parameter to successfully upgrade an ArcGIS Enterprise on Kubernetes deployment. Some upgrade settings may require their value property to be modified before being submitted as part of the upgrade operation. For example, when upgrading an ArcGIS Enterprise on Kubernetes deployment from version 11.0 to 11.1, you will need to modify the value property for the licenseUpload JSON object. All current upgrade settings, as well as information about the modifications that are needed before the deployment can be upgraded, are described in the Response properties section below.

Request parameters

Parameter Details

Parameter	Details
`upgradeId` (Required)	The unique ID associated with a patch or release. The ID can be retrieved from the `available` operation. The version manifest for a patch or release can be retrieved from the JSON view of the `available` operation. Example Use dark colors for code blocksCopy `1 {"id": "rel_234567_2000"}`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

upgradeId

(Required)

The unique ID associated with a patch or release. The ID can be retrieved from the available operation. The version manifest for a patch or release can be retrieved from the JSON view of the available operation.

Example
Use dark colors for code blocksCopy
{"id": "rel_234567_2000"}

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

Property Details

Property	Details
`updateToLatestPatch`	When set to `true`, patches included with a release will be automatically installed during the upgrade process. The default value of this property is `true`; the value should not be changed. Values: `true`
`licenseUpload`	A JSON object that stores an uploaded ArcGIS Enterprise on Kubernetes license file (`.json`). When upgrading, the `value` property must be updated to reflect the upload ID of an uploaded ArcGIS Enterprise on Kubernetes license file. Example of modified `value` property Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 { "seqNum": 1, "validFileExtensions": ["json"], "name": "licenseUpload", "description": "licenseFieldDescToken", "id": "licenseUpload", "type": "File", "value": "caf81a83-b6a7-4810-9e7c-dbff96c6050a", "required": true, "newfield": "" },`
`volumesConfig`	Note This response property has been deprecated at ArcGIS Enterprise on Kubernetes 11.1, and is only applicable to ArcGIS Enterprise on Kubernetes 11.0. A JSON object containing the storage configurations for persistent volumes that are required while upgrading.

updateToLatestPatch

When set to true, patches included with a release will be automatically installed during the upgrade process. The default value of this property is true; the value should not be changed.

Values: true

licenseUpload

A JSON object that stores an uploaded ArcGIS Enterprise on Kubernetes license file (.json). When upgrading, the value property must be updated to reflect the upload ID of an uploaded ArcGIS Enterprise on Kubernetes license file.

Example of modified value property

Use dark colors for code blocksCopy
{
  "seqNum": 1,
  "validFileExtensions": ["json"],
  "name": "licenseUpload",
  "description": "licenseFieldDescToken",
  "id": "licenseUpload",
  "type": "File",
  "value": "caf81a83-b6a7-4810-9e7c-dbff96c6050a",
  "required": true,
  "newfield": ""
},

volumesConfig

A JSON object containing the storage configurations for persistent volumes that are required while upgrading.

Example usage

The following is a sample POST request for the getUpgradeSettings operation:

Use dark colors for code blocksCopy
POST /context/admin/system/upgrades/getUpgradeSettings HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

upgradeId={"id": "rel_08042022_3000"}&
f=pjson&token=ycIwQVgej6UA_ZHHgltGsXCLRP815k4nLCiNyQEqGfWztsccgK5XdTEellUjToKS3D2UoHxGDPff4OblGKwRsXA0eb1kIIei4Bi-Ke20Nw-NSZR8Z7ILCDoxqbmOnZLoeTssYMTkd_q-_OA00Aw_W2PG5UuzLyTq2EuJBiw6eMM2hZl3AubVc9aYjblgBG4t2vT5as-IGdhOVrWf5aD7fh3L_pQ70zKCPUubzxTJYoA.

JSON Response example

Use dark colors for code blocksCopy
{
  "userInputs": [
    {
      "seqNum": 0,
      "defaultValue": false,
      "name": "updateToLatestPatch",
      "description": "updateToLatestPatch",
      "isManagerInvisibleField": true,
      "id": "updateToLatestPatch",
      "type": "Boolean",
      "value": true,
      "required": true,
      "newfield": ""
    },
    {
      "seqNum": 1,
      "validFileExtensions": ["json"],
      "name": "licenseUpload",
      "description": "licenseFieldDescToken",
      "id": "licenseUpload",
      "type": "File",
      "value": "",
      "required": true,
      "newfield": ""
    },
    {
      "orderedListofTemplates": "pvTemplateSharing,pvTemplateBlob",
      "templateName": "volumesConfig",
      "seqNum": 2,
      "defaultValue": "[{\"component\":\"BLOB\",\"labels\":{\"arcgis/tier\":\"storage\",\"arcgis/app\":\"minio\"},\"provisioningType\":\"DYNAMIC\",\"size\":\"32Gi\",\"storageClass\":\"arcgis-storage-default\"},{\"component\":\"SHARING\",\"labels\":{\"arcgis/tier\":\"api\",\"arcgis/app\":\"sharing\"},\"provisioningType\":\"DYNAMIC\",\"size\":\"16Gi\",\"storageClass\":\"arcgis-storage-default\"}]",
      "name": "volumesConfig",
      "description": "storageFieldDescToken",
      "id": "volumesConfig",
      "type": "Text",
      "isTemplateRequired": true,
      "value": "[{\"component\":\"BLOB\",\"labels\":{\"arcgis/tier\":\"storage\",\"arcgis/app\":\"minio\"},\"provisioningType\":\"DYNAMIC\",\"size\":\"32Gi\",\"storageClass\":\"arcgis-storage-default\"},{\"component\":\"SHARING\",\"labels\":{\"arcgis/tier\":\"api\",\"arcgis/app\":\"sharing\"},\"provisioningType\":\"DYNAMIC\",\"size\":\"16Gi\",\"storageClass\":\"arcgis-storage-default\"}]",
      "required": true,
      "newfield": ""
    }
  ]
}