Edit Machine

URL:
https://<root>/machines/<machine>/edit
Methods:
POST
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.1

Description

This edit operation makes changes to the configuration of the specified server machine in an ArcGIS Server site.

Request parameters

ParameterDescription

adminURL

The URL where the Administrator API is running on the server machine.

Example
1
adminURL=https://machine:6443/arcgis/admin

webServerMaxHeapSize

This property defines the maximum file size (in MB) that the web server's Java process can send to ArcGIS Server. The default value is -1 MB, meaning the web server will use one-fourth of the available system memory as the maximum heap size.

If you are observing a server performance impact and you have additional system memory, you can increase the heap size of the web server by updating this value from the default of -1 MB to an appropriate value. Note that doing so will potentially increase the amount of memory assigned to ArcGIS Server processes by your operating system.

If you have a multiple-machine site, this property should be identical on each of your machines.

Example
1
webServerMaxHeapSize=-1

webServerCertificateAlias

The alias of the web server SSL certificate.

Example
1
webServerCertificateAlias=server1

socMaxHeapSize

This property defines the maximum file size (in MB) that an individual ArcSOC process can send to the ArcGIS Server internal web server. The default value is 64 MB. You may choose to increase this property if you are experiencing performance impacts in your services, for example, if a service is failing to pass a very large JSON file to the server site. If you only want to change the maximum heap size for a specific service, you can do so by specifying the javaHeapSize framework property in the Edit Service operation.

If you have a multiple-machine site, this property should be identical on each of your machines.

Example
1
socMaxHeapSize=64

underMaintenance

This property is a flag you can use to designate the machine as being under maintenance (by you, not by the ArcGIS Server site itself). The default value is false. When set to true, this causes the machine to fail its regular health check report. ArcGIS Web Adaptor will not send service requests to any machine with this flag set to true.

A machine under maintenance will still honor administrative changes and publishing events made to the site through other ArcGIS Server machines. You can implement similar logic in your third-party load balancer or reverse proxy server to avoid forwarding service requests to machines that fail the health check. This allows you to make changes to the machine (such as updating its OS) without causing service requests to fail. When you are done performing maintenance on the machine, change this property back to false .

Values: true | false

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

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

1
2
3
4
5
6
POST /webadaptor/admin/machines/MACHINE.DOMAIN.COM/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

adminURL=https://SERVER1.DOMAIN.COM:port/arcgis/admin&webServerMaxHeapSize=-1&webServerCertificateAlias=server1&socMaxHeapSize=64&underMaintenance=false&f=json

JSON Response example

1
{"status": "success"}

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