Delete Site

URL:
https://<notebookserveradmin>/deleteSite
Methods:
POST
Required Capability:
Administrator
Version Introduced:
10.7

Description

This operation deletes the ArcGIS Notebook Server site configuration and releases all server resources. This is an unrecoverable operation. This operation is well suited for development or test servers that need to be cleaned up regularly. Use caution with this option, as it deletes all notebook containers, settings, and other configurations.

The operation performs the following tasks:

  1. Stops each ArcGIS Notebook Server machine.
  2. All running notebooks are deleted. The notebook items are preserved in the portal.
  3. Each ArcGIS Notebook Server machine is unregistered from the site.
  4. The configuration store is deleted.

This operation is available only when the ArcGIS Notebook Server machine is participating in a site.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json

Response properties

PropertyDetails

status

Indicates success or failure of the delete operation.

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