Skip to main content

Get storage state

POST 

/api/v1/storage/get-state

Returns the effective user’s full tracked storage state without pagination. Intended for restricted debugging; large accounts can produce large responses. A storage record is not an inventory or erasure certificate for every object/backend copy.

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​

Full state returned

Read the authenticated user’s storage state; no file or folder selector is needed.​

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

Request example

{}

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

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

Response example

{
"state": {
"userId": "example_123",
"folders": {},
"files": {},
"totalSizeBytes": "1",
"quotaBytes": "1",
"totalFileCount": 1,
"totalFolderCount": 1,
"createdAt": "example",
"lastModified": "example"
}
}

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

SectionStable reference
Get storage stateDOC-CP-files-data-api-getState#overview
RequestDOC-CP-files-data-api-getState#request
ResponsesDOC-CP-files-data-api-getState#responses