Skip to content
URL:
https://<root>/machines/<machine>/edit
Methods:
POST
Version Introduced:
12.0

Description

This edit operation makes changes to the server machine's configuration.

Request parameters

ParameterDescription

adminURL

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

Example
Use dark colors for code blocksCopy
1
adminURL=https://machine.example.com:21443/arcgis/admin

webServerMaxHeapSize

Defines the maximum file size (in MB) that the web server's Java process can send to ArcGIS Video 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 Video Server processes by your operating system.

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

Example
Use dark colors for code blocksCopy
1
webServerMaxHeapSize=-1

webServerCertificateAlias

The alias of the web server SSL certificate.

Example
Use dark colors for code blocksCopy
1
webServerCertificateAlias=server1

numVideoProcessors

Defines the number of video processors available on ArcGIS Video Server. The default value is 1 and can be increased if needed. For most users, 1 will be sufficient.

Example
Use dark colors for code blocksCopy
1
videoProcessors=1

f

(Required)

The response format. The default response format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Example usage

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/machines/MACHINE.EXAMPLE.COM/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

adminURL=https://machine.example.com:port/arcgis/admin&webServerMaxHeapSize=-1&webServerCertificateAlias=server1&numVideoProcessors=1&f=json

JSON Response example

Use dark colors for code blocksCopy
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.