Skip To Content
ArcGIS Developers
Dashboard

/[serverID]/update: Update Server

  • URL:https://[root]/portals/[portalID]/servers/[serverID]/update(POST only)

Example usage

Below is a sample ArcGIS Enterprise POST request for the update operation:

POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/servers/J5TUOrNQurCDgHFq/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=machine.domain.com:6443&url=https://machine.domain.com/webadaptor&isHosted=true&adminUrl=https://machine.domain.com:6443/arcgis&serverType=ArcGIS&f=pjson

Description

This operation updates the properties of an ArcGIS Server site that has been registered, or federated, with the portal. For example, you can use this operation to change the federated site that acts as the portal's hosting server.

Request parameters

ParameterDetails
name

A user-provided name for the server, with a limit of 250 characters. This parameter also supports the use of double-byte characters.

Example

name=machine.domain.com:6443
url

The externally visible URL of the ArcGIS Server site, using the fully qualified name of the machine.

Example

https://machine.domain.com/webadaptor
adminUrl

The administrative URL of the ArcGIS Server site, using the fully qualified name of the machine.

Example

https://machine.domain.com:6443/arcgis
isHosted

A Boolean property denoting whether the ArcGIS Server site will be allowed to host services for the portal (true) or will not be allowed to host services (false).

Values: true | false

serverType

The type of server being registered with the portal.

Values: ArcGIS | ARCGIS_NOTEBOOK_SERVER | ARCGIS_MISSION_SERVER

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
success

A Boolean property indicating whether the update was successful.

serverId

The unique identifier of the updated server.

JSON Response syntax

{
  "success": true | false,
  "serverId": <serverId>
}

JSON Response example

{
  "success": true,
  "serverId": "J5TUOrNQurCDgHFq"
}