Site

Archive a site

Archives the specified site. The default site cannot be archived. If the site is locked, it will be unlocked before archiving. The 'siteId' parameter is the site identifier (also known as 'hostId' or 'host' in other parts of the API).

put/api/v1/site/{siteId}/_archive

Path parameters

siteIdstring required

Identifier of the site to archive (siteId/hostId are used interchangeably)

Response

Site archived successfully

entityobject
i18nMessagesMapobject
permissionsstring[]

Changes

No recorded changes to this endpoint across all 1 revision of this API.