Skip to main content

Get storage usage and quota

POST 
/api/v1/storage/get-storage-quota

Returns the authenticated user's current tracked storage usage and quota.

The following access conditions are preserved as declared intent and are not implemented by generated code: Accepted storage owner context, Storage owner actor routing.

Use this in a guide: Build a searchable document library

Request​

Responses​

Quota information returned

Read quota and usage for the authenticated user’s storage namespace.​

Section ID: DOC-CP-files-data-api-getStorageQuota#example-storage-getStorageQuota-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-files-data-api-getStorageQuota#example-storage-getStorageQuota-response

Response example

{
  "usedBytes": "1",
  "quotaBytes": "1",
  "fileCount": 1,
  "folderCount": 1,
  "usagePercentage": 1
}

Illustrative response for Make room for another attachment. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-files-data-api-getStorageQuota#example-cookbook-core-platform-files-data-managing-json-02-response

Response example

{
  "usedBytes": "1048576",
  "quotaBytes": "1073741824",
  "fileCount": 15,
  "folderCount": 4,
  "usagePercentage": 0.098
}

Document ID: DOC-CP-files-data-api-getStorageQuota. Section identities and revisions.

SectionStable reference
Get storage usage and quotaDOC-CP-files-data-api-getStorageQuota#overview
RequestDOC-CP-files-data-api-getStorageQuota#request
ResponsesDOC-CP-files-data-api-getStorageQuota#responses