Skip To Content

Restore utility

This utility restores your site configuration based on a backup that you have previously made using the Backup utility. See Back up and restore your ArcGIS Server site configuration to learn about the backup and restore capabilities of ArcGIS Server.

This utility always uses token-based authentication.




The name of an ArcGIS Server user who will execute the utility. This doesn't need to be the same user who created the backup. If your site is configured with web-tier authentication, specify a built-in user, such as the primary site administrator account.


The password of the user who is specified with the -u parameter.


The URL of the site, in one of the following formats:

If your site is configured with web-tier authentication, you'll need to specify the local URL to your site.


The absolute path of the .agssite backup file to be restored. The ArcGIS Server account must have permission to read from this location.


Path to a folder where the utility will generate its report. The ArcGIS Server account must have write permissions to this folder. The report is always written to the console, regardless of whether you provide this path.


Prints help for the utility.


An optional parameter to disable SSL certification verification.


An optional property that specifies the location of a properties file, for instance, /home/arcgis/serverbackups/ The properties file must contain the following properties:

  • User name
  • Password
  • Site
  • File



The following example restores a backup from a file named Jan-24-2013_13-25-23.agssite:


If you implemented logic that automates the execution of these utilities, you need to update your scripts to remove the Python dependencies. The following are examples:

  • <ArcGIS Server installation location>/arcgis/server/tools/python
  • The .py extension when referring to the name of the command line utility

See the following example for correct usage:

<ArcGIS Server installation location>/arcgis/server/tools/admin/restore -u admin -p admin -s -f /tmp/mybackups/Jan-24-2013_13-25-23.agssite -r /tmp/mybackups

In this topic
  1. Parameters
  2. Examples