Sites.Archive.All
Export JSON
Export CSV
Copy URL
Print
Application
Read
All Resources
Allow the application to archive/reactivate site collections without a signed in user.
Permission data: April 6, 2026 at 4:06 AM UTC
Delegated Access
App-Only Access
Permission Details
Application Permission
Archive/reactivate Site Collections without a signed in user.
Allow the application to archive/reactivate site collections without a signed in user.
Permission ID:
e3530185-4080-478c-a4ab-39322704df58
Properties
Microsoft Graph v1.0
mapped-docs
Properties is shown from stable Microsoft Graph v1.0 metadata.
| Property | Type | Description |
|---|---|---|
dataLocationCode |
string |
The geographic region code for where this site collection resides. Only present for multi-geo tenants. Read-only. |
hostname |
string |
The hostname for the site collection. Read-only. |
root |
[root][] |
If present, indicates that this is a root site collection in SharePoint. Read-only. |
archivalDetails |
[siteArchivalDetails][] |
Represents whether the site collection is recently archived, fully archived, or reactivating. The possible values are: recentlyArchived, fullyArchived, reactivating, unknownFutureValue. |
analytics |
object |
Analytics about the view activities that took place on this site. |
columns |
columnDefinition collection |
The collection of column definitions reusable across lists under this site. |
contentTypes |
contentType collection |
The collection of content types defined for this site. |
createdBy |
object |
Identity of the user, device, or application that created the item. Read-only. |
createdByUser |
object |
Identity of the user who created the item. Read-only. |
createdDateTime |
date-time |
Date and time of item creation. Read-only. |
description |
stringNullable |
Provides a user-visible description of the item. Optional. |
displayName |
stringNullable |
The full title for the site. Read-only. |
drive |
object |
The default drive (document library) for this site. |
drives |
drive collection |
The collection of drives (document libraries) under this site. |
error |
object |
Showing 15 of 36 properties.
JSON Representation
Microsoft Graph v1.0
mapped-docs
JSON representation is shown from stable Microsoft Graph v1.0 metadata.
JSON representation
{
"hostname": "contoso.sharepoint.com",
"dataLocationCode": "EUR",
"root": {
"@odata.type": "microsoft.graph.root"
},
"archivalDetails": {
"@odata.type": "microsoft.graph.siteArchivalDetails",
"archiveStatus": "fullyArchived"
}
}Relationships
Microsoft Graph v1.0
mapped
Relationships is shown from stable Microsoft Graph v1.0 metadata.
| Relationship | Type | Description |
|---|---|---|
drive |
drive |
Default drive for the site. |
drives |
drive collection |
Document libraries under the site. |
lists |
list collection |
Lists under the site. |
sites |
site collection |
Subsites under the site. |
permissions |
permission collection |
Permissions associated with the site. |
columns |
columnDefinition collection |
The collection of column definitions reusable across lists under this site. |
contentTypes |
contentType collection |
The collection of content types defined for this site. |
externalColumns |
columnDefinition collection |
Related externalColumns data exposed by this resource. |
items |
baseItem collection |
Used to address any item contained in this site. This collection can't be enumerated. |
operations |
richLongRunningOperation collection |
The collection of long-running operations on the site. |
pages |
baseSitePage collection |
The collection of pages in the baseSitePages list in this site. |
termStores |
termStore.store collection |
The collection of termStores under this site. |
contentModels |
contentModel collection |
The collection of content models applied to this site. |
documentProcessingJobs |
documentProcessingJob collection |
The document processing jobs running on this site. |
extensions |
extension collection |
The collection of open extensions defined for this site. Nullable. |
pageTemplates |
pageTemplate collection |
The collection of page templates on this site. |
Graph Methods
Delegated access
App-only access
Exact Microsoft Learn match
Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
No API methods available for this version.
Exact Microsoft Learn match
Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
| Methods |
|---|
POST
/sites/{site-id}/archive
|
POST
/sites/{site-id}/unarchive
|
Exact Microsoft Learn PowerShell match
Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
No deterministic PowerShell command map is available for this permission.
Browse PowerShell docsCode Examples
C# / .NET SDK
site: archive
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Sites["{site-id}"].Archive.PostAsync();
JavaScript
site: archive
const options = {
authProvider,
};
const client = Client.init(options);
await client.api('/sites/contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740/archive')
.version('beta')
.post();
PowerShell
site: archive
Import-Module Microsoft.Graph.Beta.Sites
Invoke-MgBetaArchiveSite -SiteId $siteId
Python
site: archive
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
await graph_client.sites.by_site_id('site-id').archive.post()App Registration
1
Navigate to Azure Portal
Go to App registrations in Microsoft Entra admin center
2
Add API Permission
Select your app → API permissions → Add a permission → Microsoft Graph
3
Select Permission Type
Choose Application permissions and search for Sites.Archive.All
4
Grant Admin Consent
Application permissions always require admin consent.