site: archive
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Archive an active SharePoint site.
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Sites.FullControl.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Sites.FullControl.All | Not available. |
In delegated scenarios, the signed-in user must also be assigned one of the following supported Microsoft Entra roles for this operation:
- SharePoint Administrator
- Global Administrator
SharePoint Administrator is the least privileged role for this operation.
HTTP request
POST /sites/{site-id}/archive
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.
Examples
Request
The following example shows how to archive a site.
POST https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740/archive
Response
The following example shows the response.
HTTP/1.1 204 No Content