- URL:
- https://<root>/machines/rename
- Methods:
POST- Version Introduced:
- 10.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The rename operation updates any references to the machine when a ArcGIS Server site is renamed. This operation is not automatically called when a registered machine's name is changed. Rather, you must manually call this operation aftering changing a machine's name.
By default, when any server machine that participates in a site is restarted, it can identify a name change. When it does, it updates itself and all its references.
Request parameters
| Parameter | Description |
|---|---|
| The former name of the server machine that is registered with the site. Example |
| The new name of the server machine. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the rename operation:
POST /<context>/admin/machines/rename HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
machineName=MACHINE.EXAMPLE.COM&newMachineName=CHANGED.EXAMPLE.COM&f=jsonJSON Response example
{"status": "success"}