Microsoft Graph Drives is the part of Microsoft Graph that lets apps discover and work with files across OneDrive and SharePoint using a single, consistent REST API. A drive represents a top-level document library—personal or shared—and exposes its files and folders (driveItems) in the same way whether they live in a user’s OneDrive, a SharePoint site, a Microsoft 365 Group, or a Team.
openapi: 3.1.0
info:
title: Microsoft Graph Drives
description: Needs a description.
paths:
/drives:
description: Provides operations to manage the collection of drive entities.
get:
tags:
- Drives.drive
summary: Microsoft Graph Get entities from drives
operationId: drives.drive.ListDrive
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.driveCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Drives.drive
summary: Microsoft Graph Add new entity to drives
operationId: drives.drive.CreateDrive
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{drive-id}:
description: Provides operations to manage the collection of drive entities.
get:
tags:
- Drives.drive
summary: Microsoft Graph Get entity from drives by key
operationId: drives.drive.GetDrive
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Drives.drive
summary: Microsoft Graph Update entity in drives
operationId: drives.drive.UpdateDrive
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Drives.drive
summary: Microsoft Graph Delete entity from drives
operationId: drives.drive.DeleteDrive
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/bundles:
description: >-
Provides operations to manage the bundles property of the
microsoft.graph.drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get bundles from drives
description: >-
Collection of bundles (albums and multi-select-shared sets of items).
Only in personal OneDrive.
operationId: drives.ListBundles
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.driveItemCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- drives.driveItem
summary: Microsoft Graph Create new navigation property to bundles for drives
operationId: drives.CreateBundles
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/bundles/{driveItem-id}:
description: >-
Provides operations to manage the bundles property of the
microsoft.graph.drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get bundles from drives
description: >-
Collection of bundles (albums and multi-select-shared sets of items).
Only in personal OneDrive.
operationId: drives.GetBundles
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
/drives/{drive-id}/bundles/{driveItem-id}/content:
description: Provides operations to manage the media for the drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get content for the navigation property bundles from drives
description: The content stream, if the item represents a file.
operationId: drives.GetBundlesContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- drives.driveItem
summary: Microsoft Graph Update content for the navigation property bundles in drives
description: The content stream, if the item represents a file.
operationId: drives.UpdateBundlesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- drives.driveItem
summary: Microsoft Graph Delete content for the navigation property bundles in drives
description: The content stream, if the item represents a file.
operationId: drives.DeleteBundlesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
/drives/{drive-id}/bundles/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get the number of the resource
operationId: drives.bundles.GetCount-c935
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/createdByUser:
description: >-
Provides operations to manage the createdByUser property of the
microsoft.graph.baseItem entity.
get:
tags:
- Drives.user
summary: Microsoft Graph Get createdByUser from drives
description: Identity of the user who created the item. Read-only.
operationId: drives.GetCreatedByUser
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
x-ms-docs-grouped-path:
- /drives/{drive-id}/items/{driveItem-id}/createdByUser
- /drives/{drive-id}/list/createdByUser
- /drives/{drive-id}/list/items/{listItem-id}/createdByUser
/drives/{drive-id}/createdByUser/mailboxSettings:
get:
tags:
- Drives.user
summary: Microsoft Graph Get mailboxSettings property value
description: >-
Settings for the primary mailbox of the signed-in user. You can get or
update settings for sending automatic replies to incoming messages,
locale, and time zone. Returned only on $select.
operationId: drives.createdByUser.GetMailboxSettings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
patch:
tags:
- Drives.user
summary: Microsoft Graph Update property mailboxSettings value.
operationId: drives.createdByUser.UpdateMailboxSettings
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/createdByUser/serviceProvisioningErrors:
get:
tags:
- Drives.user
summary: Microsoft Graph Get serviceProvisioningErrors property value
description: >-
Errors published by a federated service describing a nontransient,
service-specific error regarding the properties or link from a user
object. Supports $filter (eq, not, for isResolved and serviceInstance).
operationId: drives.createdByUser.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/createdByUser/serviceProvisioningErrors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Drives.user
summary: Microsoft Graph Get the number of the resource
operationId: drives.createdByUser.ServiceProvisioningErrors.GetCount-37a0
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/following:
description: >-
Provides operations to manage the following property of the
microsoft.graph.drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get following from drives
description: The list of items the user is following. Only in OneDrive for Business.
operationId: drives.ListFollowing
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.driveItemCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/following/{driveItem-id}:
description: >-
Provides operations to manage the following property of the
microsoft.graph.drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get following from drives
description: The list of items the user is following. Only in OneDrive for Business.
operationId: drives.GetFollowing
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
/drives/{drive-id}/following/{driveItem-id}/content:
description: Provides operations to manage the media for the drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get content for the navigation property following from drives
description: The content stream, if the item represents a file.
operationId: drives.GetFollowingContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- drives.driveItem
summary: Microsoft Graph Update content for the navigation property following in drives
description: The content stream, if the item represents a file.
operationId: drives.UpdateFollowingContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- drives.driveItem
summary: Microsoft Graph Delete content for the navigation property following in drives
description: The content stream, if the item represents a file.
operationId: drives.DeleteFollowingContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
/drives/{drive-id}/following/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get the number of the resource
operationId: drives.following.GetCount-16f3
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/items:
description: >-
Provides operations to manage the items property of the
microsoft.graph.drive entity.
get:
tags:
- drives.driveItem
summary: 'Microsoft Graph drive: sharedWithMe (deprecated)'
description: >-
Get a list of driveItem objects shared with the owner of a drive. The
driveItems returned from the sharedWithMe method always include the
remoteItem facet that indicates they are items from a different drive.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/drive-sharedwithme?view=graph-rest-1.0
operationId: drives.ListItems
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.driveItemCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- drives.driveItem
summary: Microsoft Graph Create new navigation property to items for drives
operationId: drives.CreateItems
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/drives/{drive-id}/items/{driveItem-id}:
description: >-
Provides operations to manage the items property of the
microsoft.graph.drive entity.
get:
tags:
- drives.driveItem
summary: Microsoft Graph Get items from drives
description: All items contained in the drive. Read-only. Nullable.
operationId: drives.GetItems
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.driveItem
summary: Microsoft Graph Update the navigation property items in drives
operationId: drives.UpdateItems
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- drives.driveItem
summary: Microsoft Graph Delete navigation property items for drives
operationId: drives.DeleteItems
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/erro
# --- truncated at 32 KB (7572 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/drives-openapi-original.yml