/[serverID]/update: Update Server

URL:
https://[root]/portals/[portalID]/servers/[serverID]/update
Methods:
POST

Example usage

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

1
2
3
4
5
6
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

The update 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

1
name=machine.domain.com:6443

url

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

Example

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

adminUrl

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

Example

1
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

1
2
3
4
{
  "success": true | false,
  "serverId": <serverId>
}

JSON Response example

1
2
3
4
{
  "success": true,
  "serverId": "J5TUOrNQurCDgHFq"
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close