Aller au contenu principal

M365

25 routes de l'API publique. Textes de la source : openapi-csp.json du dépôt platform.

Create m365endpoint​

POST /m365/endpoints

Accès : Clé API du MSP, portée operate.

Corps de la requête (application/json)

NomTypeObligatoireDescription
client_idstring (uuid)ouiClient of the caller's MSP, else 404.
tenantstringouiEntra tenant: tenant ID (GUID) or domain name, typed by the MSP. Longueur : 1 à 255.

Réponses

CodeDescription
201Success
defaultError (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 201 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)ouiCreated once, named after the tenant until M365 reads its primary domain.
tenantstringouiTenant as normalised by M365. Longueur : 1 à 255.
enrollment_urlstringouiLink for the tenant admin: GET /m365/enrollment/entry
progress_tokenstringouiBearer token of GET /m365/enrollment/progress
expires_atstring (date-time)ouiExpiry of the link.

Connection: status, Graph roles granted, certificate expiry​

GET /endpoints/{id}/m365/connection

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)oui
ms_tenant_idstring (uuid)oui
app_idstring (uuid)oui
status"connected" | "reconnect_required" | "permission_missing" | "unavailable"oui
certificate_expires_atstring (date-time)oui
key_versionintegerouiValeur minimum : 0.
permissionsarray of "User.Read.All" | "Group.Read.All" | "Organization.Read.All" | "Reports.Read.All" | "Mail.Read" | "MailboxSettings.Read" | "Calendars.Read" | "Contacts.Read" | "Files.Read.All" | "Sites.Read.All" | "Team.ReadBasic.All" | "TeamSettings.Read.All" | "Channel.ReadBasic.All" | "ChannelMember.Read.All" | "ChannelMessage.Read.All" | "Application.ReadWrite.OwnedBy" | "AppRoleAssignment.ReadWrite.All"oui
checked_atstring (date-time) | nulloui

Discovery status and resources of the tenant​

GET /endpoints/{id}/m365/resources

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
kindrequête"user" | "shared_mailbox" | "group" | "team" | "site" | "drive"non
parent_ms_idrequêtestringnonLongueur : 1 à 1024.
statusrequête"discovered" | "protected" | "gone"non
cursorrequêtestringnon
limitrequêteintegernonValeur : 1 à 500.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
discoveryobject | nulloui
resourcesarray of objectoui
resources[].idstring (uuid)oui
resources[].endpoint_idstring (uuid)oui
resources[].ms_idstringouiLongueur : 1 à 1024.
resources[].kind"user" | "shared_mailbox" | "group" | "team" | "site" | "drive"oui
resources[].parent_ms_idstring | nulloui
resources[].display_namestringouiLongueur maximum : 1024.
resources[].status"discovered" | "protected" | "gone"oui
resources[].billablebooleanoui
resources[].last_success_atstring (date-time) | nulloui
resources[].gone_atstring (date-time) | nulloui
resources[].retain_untilstring (date-time) | nulloui
resources[].workloadsobjectoui
next_cursorstring | nulloui

Graph roles of the latest complete check​

GET /endpoints/{id}/m365/permissions

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)oui
status"unknown" | "verified" | "access_denied" | "throttled" | "unavailable"oui
attempted_atstring (date-time) | nulloui
observationobject | nulloui

Observed changes of the Graph roles, newest first​

GET /endpoints/{id}/m365/permissions/history

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
cursorrequêtestringnon
limitrequêteintegernonValeur : 1 à 100.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)oui
first_observed_atstring (date-time) | nulloui
entriesarray of objectoui
entries[].idstring (uuid)oui
entries[].observed_atstring (date-time)oui
entries[].change"baseline" | "added" | "removed"oui
entries[].permissionobjectoui
next_cursorstring | nulloui

New enrollment link to reconnect the tenant​

POST /endpoints/{id}/m365/reconnect

Accès : Clé API du MSP, portée operate.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
201Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 201 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)oui
tenantstring (uuid)oui
enrollment_urlstring (uri)oui
progress_tokenstringoui
expires_atstring (date-time)oui

Back up now, outside the schedule​

POST /endpoints/{id}/m365/backups/run

Accès : Clé API du MSP, portée operate.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
201Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 201 (application/json)

NomTypeObligatoireDescription
runobjectoui
run.idstring (uuid)oui
run.endpoint_idstring (uuid)oui
run.daystring (date)oui
run.trigger"scheduled" | "manual"oui
run.status"pending" | "running" | "succeeded" | "partial" | "failed" | "skipped"oui
run.started_atstring (date-time)oui
run.ended_atstring (date-time) | nulloui
run.postponed_atstring (date-time) | nullnon
run.unitsobjectoui
run.issuesobjectoui

Backup runs, newest first​

GET /endpoints/{id}/m365/runs

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
limitrequêteintegernonValeur : 1 à 100.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
runsarray of objectoui
runs[].idstring (uuid)oui
runs[].endpoint_idstring (uuid)oui
runs[].daystring (date)oui
runs[].trigger"scheduled" | "manual"oui
runs[].status"pending" | "running" | "succeeded" | "partial" | "failed" | "skipped"oui
runs[].started_atstring (date-time)oui
runs[].ended_atstring (date-time) | nulloui
runs[].postponed_atstring (date-time) | nullnon
runs[].unitsobjectoui
runs[].issuesobjectoui

One run with its work units​

GET /endpoints/{id}/m365/runs/{run_id}

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
run_idcheminstring (uuid)oui

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
runobjectoui
run.idstring (uuid)oui
run.endpoint_idstring (uuid)oui
run.daystring (date)oui
run.trigger"scheduled" | "manual"oui
run.status"pending" | "running" | "succeeded" | "partial" | "failed" | "skipped"oui
run.started_atstring (date-time)oui
run.ended_atstring (date-time) | nulloui
run.postponed_atstring (date-time) | nullnon
run.unitsobjectoui
run.issuesobjectoui
unitsarray of objectoui
units[].idstring (uuid)oui
units[].run_idstring (uuid)oui
units[].resource_idstring (uuid)oui
units[].workload"mail" | "calendar" | "onedrive" | "sharepoint" | "teams_structure" | "contacts" | "teams_messages"oui
units[].status"pending" | "running" | "succeeded" | "failed" | "skipped"oui
units[].attemptsintegerouiValeur minimum : 0.
units[].full_scanbooleanoui
units[].statsobjectoui
units[].skipped_itemsarray of stringouiÉléments maximum : 100.
units[].error"throttled" | "access_denied" | "not_found" | "transport" | "storage" | "invalid_response" | "skipped_in_progress" | "internal" | "repository_migrating" | "license_required" | "license_new_user" | nulloui
units[].started_atstring (date-time) | nulloui
units[].ended_atstring (date-time) | nulloui

Children of a folder of a resource at a point in time​

GET /endpoints/{id}/m365/resources/{resource_id}/{workload}/browse

Accès : Clé API du MSP, portée browse.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
resource_idcheminstring (uuid)oui
workloadchemin"mail" | "calendar" | "onedrive" | "sharepoint" | "teams_structure" | "contacts" | "teams_messages"oui
atrequêtestring (date-time)non
parentrequêtestringnonLongueur : 1 à 1024.
include_deletedrequête"true" | "false"non
cursorrequêtestringnon
limitrequêteintegernonValeur : 1 à 500.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
resource_idstring (uuid)oui
workload"mail" | "calendar" | "onedrive" | "sharepoint" | "teams_structure" | "contacts" | "teams_messages"oui
atstring (date-time)oui
parentstring | nulloui
entriesarray of objectoui
entries[].item_idstringouiLongueur : 1 à 1024.
entries[].version_idstring (uuid)oui
entries[].kind"contact" | "folder" | "message" | "file" | "calendar" | "event" | "team" | "channel"oui
entries[].namestringouiLongueur maximum : 1024.
entries[].parent_idstring | nulloui
entries[].sizeintegerouiValeur minimum : 0.
entries[].modified_atstring (date-time) | nulloui
entries[].valid_fromstring (date-time)oui
entries[].valid_tostring (date-time) | nulloui
entries[].deletedbooleanoui
next_cursorstring | nulloui

Versions of an item (the item id is the rest of the path and may hold a /)​

GET /endpoints/{id}/m365/resources/{resource_id}/{workload}/items/{item_id}/versions

Accès : Clé API du MSP, portée browse.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
resource_idcheminstring (uuid)oui
workloadchemin"mail" | "calendar" | "onedrive" | "sharepoint" | "teams_structure" | "contacts" | "teams_messages"oui
item_idcheminstringouiLongueur : 1 à 1024.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
resource_idstring (uuid)oui
workload"mail" | "calendar" | "onedrive" | "sharepoint" | "teams_structure" | "contacts" | "teams_messages"oui
item_idstringoui
versionsarray of objectoui
versions[].item_idstringouiLongueur : 1 à 1024.
versions[].version_idstring (uuid)oui
versions[].kind"contact" | "folder" | "message" | "file" | "calendar" | "event" | "team" | "channel"oui
versions[].namestringouiLongueur maximum : 1024.
versions[].parent_idstring | nulloui
versions[].sizeintegerouiValeur minimum : 0.
versions[].modified_atstring (date-time) | nulloui
versions[].valid_fromstring (date-time)oui
versions[].valid_tostring (date-time) | nulloui
versions[].deletedbooleanoui

Search on the metadata of the backed-up items​

GET /endpoints/{id}/m365/search

Accès : Clé API du MSP, portée browse.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
qrequêtestringnonLongueur : 2 à 256.
workloadrequêtestringnonLongueur maximum : 256.
resource_idrequêtestring (uuid)non
kindrequêtestringnonLongueur maximum : 256.
extensionrequêtestringnon
fromrequêtestring (date-time)non
torequêtestring (date-time)non
min_sizerequêteintegernonValeur minimum : 0.
max_sizerequêteintegernonValeur minimum : 0.
atrequêtestring (date-time)non
include_deletedrequête"true" | "false"non
cursorrequêtestringnon
limitrequêteintegernonValeur : 1 à 100.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
atstring (date-time) | nulloui
hitsarray of objectoui
hits[].resource_idstring (uuid)oui
hits[].workload"mail" | "calendar" | "onedrive" | "sharepoint" | "teams_structure" | "contacts" | "teams_messages"oui
hits[].item_idstringouiLongueur : 1 à 1024.
hits[].version_idstring (uuid)oui
hits[].kind"contact" | "folder" | "message" | "file" | "calendar" | "event" | "team" | "channel"oui
hits[].namestringouiLongueur maximum : 1024.
hits[].parent_idstring | nulloui
hits[].pathstringoui
hits[].sizeintegerouiValeur minimum : 0.
hits[].item_atstring (date-time)oui
hits[].valid_fromstring (date-time)oui
hits[].valid_tostring (date-time) | nulloui
hits[].deletedbooleanoui
next_cursorstring | nulloui

Backup time, time zone and retention​

GET /endpoints/{id}/m365/settings

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
backup_timestringoui
timezonestringouiLongueur : 1 à 64.
retention_daysintegerouiValeur : 1 à 36525.
retention_pendingobject | nulloui
endpoint_idstring (uuid)oui
next_backup_atstring (date-time)oui
manual_runobjectoui
manual_run.availablebooleanoui
manual_run.reason"running" | "already_succeeded_today" | "nothing_to_back_up" | "msp_suspended" | "license_required" | nulloui

Change the backup time, time zone or retention​

PATCH /endpoints/{id}/m365/settings

Accès : Clé API du MSP, portée operate.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Corps de la requête (application/json)

NomTypeObligatoireDescription
backup_timestringnon
timezonestringnonLongueur : 1 à 64.
retention_daysintegernonValeur : 1 à 36525.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
backup_timestringoui
timezonestringouiLongueur : 1 à 64.
retention_daysintegerouiValeur : 1 à 36525.
retention_pendingobject | nulloui
endpoint_idstring (uuid)oui
next_backup_atstring (date-time)oui
manual_runobjectoui
manual_run.availablebooleanoui
manual_run.reason"running" | "already_succeeded_today" | "nothing_to_back_up" | "msp_suspended" | "license_required" | nulloui

Cancel a pending shorter retention​

POST /endpoints/{id}/m365/settings/retention/cancel

Accès : Clé API du MSP, portée operate.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
backup_timestringoui
timezonestringouiLongueur : 1 à 64.
retention_daysintegerouiValeur : 1 à 36525.
retention_pendingobject | nulloui
endpoint_idstring (uuid)oui
next_backup_atstring (date-time)oui
manual_runobjectoui
manual_run.availablebooleanoui
manual_run.reason"running" | "already_succeeded_today" | "nothing_to_back_up" | "msp_suspended" | "license_required" | nulloui

Last daily reading of the usage reports and its month to date​

GET /endpoints/{id}/m365/consumption

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)oui
latestobject | nulloui
checkobject | nulloui
monthobject | nulloui

Read the usage reports again now​

POST /endpoints/{id}/m365/consumption/check

Accès : Clé API du MSP, portée operate.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
202Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 202 (application/json)

NomTypeObligatoireDescription
endpoint_idstring (uuid)oui
latestobject | nulloui
checkobject | nulloui
monthobject | nulloui

Exports, newest first​

GET /endpoints/{id}/m365/exports

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
limitrequêteintegernonValeur : 1 à 100.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
exportsarray of objectoui
exports[].idstring (uuid)oui
exports[].endpoint_idstring (uuid)oui
exports[].resource_idstring (uuid)oui
exports[].workload"mail" | "onedrive" | "sharepoint" | "calendar" | "contacts" | "teams_messages"oui
exports[].format"native" | "pst"oui
exports[].contentarray of "mail" | "calendar" | nulloui
exports[].coverageobject | nulloui
exports[].atstring (date-time)oui
exports[].selectedinteger | nulloui
exports[].status"queued" | "running" | "ready" | "failed" | "expired"oui
exports[].requested_bystring (uuid) | nulloui
exports[].partsarray of objectoui
exports[].itemsintegerouiValeur minimum : 0.
exports[].bytesintegerouiValeur minimum : 0.
exports[].error"repository" | "storage" | "integrity" | "internal" | nulloui
exports[].created_atstring (date-time)oui
exports[].ready_atstring (date-time) | nulloui
exports[].expires_atstring (date-time) | nulloui

Start an export (native files or PST)​

POST /endpoints/{id}/m365/exports

Accès : Clé API du MSP, portée operate.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Corps de la requête (application/json)

NomTypeObligatoireDescription
resource_idstring (uuid)oui
workload"mail" | "onedrive" | "sharepoint" | "calendar" | "contacts" | "teams_messages"oui
atstring (date-time)non
item_idsarray of string | nulloui
format"native" | "pst"non
contentarray of "mail" | "calendar"nonÉléments : 1 à 2.
accept_gapstruenon

Réponses

CodeDescription
202Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 202 (application/json)

NomTypeObligatoireDescription
idstring (uuid)oui
endpoint_idstring (uuid)oui
resource_idstring (uuid)oui
workload"mail" | "onedrive" | "sharepoint" | "calendar" | "contacts" | "teams_messages"oui
format"native" | "pst"oui
contentarray of "mail" | "calendar" | nulloui
coverageobject | nulloui
atstring (date-time)oui
selectedinteger | nulloui
status"queued" | "running" | "ready" | "failed" | "expired"oui
requested_bystring (uuid) | nulloui
partsarray of objectoui
parts[].numberintegerouiValeur minimum : 0.
parts[].sizeintegerouiValeur minimum : 0.
parts[].itemsintegerouiValeur minimum : 0.
itemsintegerouiValeur minimum : 0.
bytesintegerouiValeur minimum : 0.
error"repository" | "storage" | "integrity" | "internal" | nulloui
created_atstring (date-time)oui
ready_atstring (date-time) | nulloui
expires_atstring (date-time) | nulloui

One export: state, progress, parts, expiry​

GET /endpoints/{id}/m365/exports/{export_id}

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
export_idcheminstring (uuid)oui

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
idstring (uuid)oui
endpoint_idstring (uuid)oui
resource_idstring (uuid)oui
workload"mail" | "onedrive" | "sharepoint" | "calendar" | "contacts" | "teams_messages"oui
format"native" | "pst"oui
contentarray of "mail" | "calendar" | nulloui
coverageobject | nulloui
atstring (date-time)oui
selectedinteger | nulloui
status"queued" | "running" | "ready" | "failed" | "expired"oui
requested_bystring (uuid) | nulloui
partsarray of objectoui
parts[].numberintegerouiValeur minimum : 0.
parts[].sizeintegerouiValeur minimum : 0.
parts[].itemsintegerouiValeur minimum : 0.
itemsintegerouiValeur minimum : 0.
bytesintegerouiValeur minimum : 0.
error"repository" | "storage" | "integrity" | "internal" | nulloui
created_atstring (date-time)oui
ready_atstring (date-time) | nulloui
expires_atstring (date-time) | nulloui

Download link of one part of a ready export​

GET /endpoints/{id}/m365/exports/{export_id}/parts/{number}

Accès : Clé API du MSP, portée browse.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
export_idcheminstring (uuid)oui
numbercheminintegerouiValeur : 1 à 99999.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
urlstring (uri) | stringoui
expires_atstring (date-time)oui
file_namestringouiLongueur minimum : 1.

Content of one part (ZIP)​

GET /endpoints/{id}/m365/exports/{export_id}/parts/{number}/content

Accès : Clé API du MSP, portée browse.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
export_idcheminstring (uuid)oui
numbercheminintegerouiValeur : 1 à 99999.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Restore turned on or off for the tenant​

GET /endpoints/{id}/m365/restore/activation

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
enabledbooleanoui
tenant_domainstring | nulloui
changed_bystring (uuid) | nulloui
changed_atstring (date-time) | nulloui

Restores, newest first​

GET /endpoints/{id}/m365/restores

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
limitrequêteintegernonValeur : 1 à 100.

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
restoresarray of objectoui
restores[].idstring (uuid)oui
restores[].endpoint_idstring (uuid)oui
restores[].tenant_idstring (uuid)oui
restores[].resource_idstring (uuid)oui
restores[].workload"onedrive" | "sharepoint"oui
restores[].resource_ms_idstringouiLongueur minimum : 1.
restores[].site_idstring | nulloui
restores[].drive_idstring | nulloui
restores[].atstring (date-time)oui
restores[].selectedinteger | nulloui
restores[].target"restore_folder" | "original"oui
restores[].restore_folderstring | nulloui
restores[].conflict_policy"skip" | "keep_both" | "overwrite"oui
restores[].status"queued" | "running" | "paused" | "partial" | "complete" | "failed" | "cancelled"oui
restores[].cancel_requestedbooleanoui
restores[].confirmation_reasonsarray of "overwrite" | "whole_resource" | "items" | "bytes"oui
restores[].requested_bystring (uuid) | nulloui
restores[].itemsintegerouiValeur minimum : 0.
restores[].bytesintegerouiValeur minimum : 0.
restores[].progressobjectoui
restores[].error"access_denied" | "target_missing" | "repository" | "internal" | "msp_suspended" | "endpoint_deleted" | "requester_not_allowed" | nulloui
restores[].created_atstring (date-time)oui
restores[].started_atstring (date-time) | nulloui
restores[].finished_atstring (date-time) | nulloui

One restore: state, totals, typed error​

GET /endpoints/{id}/m365/restores/{restore_id}

Accès : Clé API du MSP, portée read.

Paramètres

NomEmplacementTypeObligatoireDescription
idcheminstring (uuid)ouiAn active M365 endpoint of the MSP.
restore_idcheminstring (uuid)oui

Réponses

CodeDescription
200Success
defaultError: the API error (401, 403, 404 before the M365 router) or the M365 error of the route

Réponse 200 (application/json)

NomTypeObligatoireDescription
idstring (uuid)oui
endpoint_idstring (uuid)oui
tenant_idstring (uuid)oui
resource_idstring (uuid)oui
workload"onedrive" | "sharepoint"oui
resource_ms_idstringouiLongueur minimum : 1.
site_idstring | nulloui
drive_idstring | nulloui
atstring (date-time)oui
selectedinteger | nulloui
target"restore_folder" | "original"oui
restore_folderstring | nulloui
conflict_policy"skip" | "keep_both" | "overwrite"oui
status"queued" | "running" | "paused" | "partial" | "complete" | "failed" | "cancelled"oui
cancel_requestedbooleanoui
confirmation_reasonsarray of "overwrite" | "whole_resource" | "items" | "bytes"oui
requested_bystring (uuid) | nulloui
itemsintegerouiValeur minimum : 0.
bytesintegerouiValeur minimum : 0.
progressobjectoui
progress.restoredintegerouiValeur minimum : 0.
progress.skippedintegerouiValeur minimum : 0.
progress.failedintegerouiValeur minimum : 0.
progress.reviewintegerouiValeur minimum : 0.
progress.cancelledintegerouiValeur minimum : 0.
error"access_denied" | "target_missing" | "repository" | "internal" | "msp_suspended" | "endpoint_deleted" | "requester_not_allowed" | nulloui
created_atstring (date-time)oui
started_atstring (date-time) | nulloui
finished_atstring (date-time) | nulloui