API
Storage Usage API

Storage Usage API

Two API resources are used to report on storage usage. CustomerStorage gives aggregate storage usage information for individual Spaces and across your whole Customer account, and ImageStorage gives usage information about a single asset.

This needs to be generalised to report on usage per delivery channel.

CustomerStorage

A CustomerStorage object is a read-only resource - you cannot update this information. It shows the current storage use for a Customer or for an individual Space within a customer.

{
    "@context": "https://dlcs.github.io/vocab/context/future.json",
    "@id": "https://api.dlcs.io/customers/21/storage",
    "@type": "vocab:CustomerStorage",
    "storagePolicy": "https://api.dlcs.io/storagePolicies/default",
    "numberOfStoredImages": 177,
    "totalSizeOfStoredImages": 380002946,
    "totalSizeOfThumbnails": 29904731,
    "lastCalculated": "2023-08-23T13:20:03.127223+00:00"
}
/customers/{customer}/storage
/customers/{customer}/spaces/{space}/storage
MethodLabelExpectsReturnsStatus
GETRetrieve Customer Storage-vocab:CustomerStorage200 OK, 404 Not Found

storagePolicy

When the customer storage resource is for a Customer rather than a space, it will include this link property which describes the total storage permitted across all the Customer’s spaces.

domainrangereadonlywriteonly
vocab:CustomerStorage🔗 vocab:StoragePolicyTrueFalse

An example linked storage policy (also a non editable resource for obvious reasons) might be:

/customers/{customer}/storagePolicy/{storagePolicy}

{
    "@context": "https://dlcs.github.io/vocab/context/future.json",
    "@id": "https://api.dlcs.io/storagePolicies/default",
    "@type": "vocab:StoragePolicy",
    "maximumNumberOfStoredImages": 1000000000,
    "maximumTotalSizeOfStoredImages": 1125899906842624
}

These limits are set on your Customer account; you can use them to compare with the current storage usage. The platform requires storage capacity to service the images registered by customers. This setting governs how much capacity the platform can use for a Customer across all the customer’s spaces. Capacity is affected by image optimisation policy (higher quality = more storage used) and the absolute size of the images (pixel dimensions).

numberOfStoredImages

This is the total number of assets (not just images) you have in the platform.

domainrangereadonlywriteonly
vocab:CustomerStoragexsd:integerTrueFalse

totalSizeOfStoredImages

Total storage usage for assets excluding thumbnails, in bytes.

domainrangereadonlywriteonly
vocab:CustomerStoragexsd:integerTrueFalse

totalSizeOfThumbnails

Total storage usage for thumbnails, in bytes

domainrangereadonlywriteonly
vocab:CustomerStoragexsd:integerTrueFalse

lastCalculated

When the platform last evaluated storage use to generate this resource.

domainrangereadonlywriteonly
vocab:CustomerStoragexsd:dateTimeTrueFalse

ImageStorage

A vocab:ImageStorage object provides storage usage information about an individual asset.

This needs to be generalised to report on usage per delivery channel.

{
    "@context": "https://dlcs.github.io/vocab/context/future.json",
    "@id": "https://api.dlcs.io/customers/2/spaces/5/images/my-image/storage",
    "@type": "vocab:ImageStorage",
    "thumbnailSize": 393301,
    "size": 4124585,
    "lastChecked": "2023-07-13T09:42:29.346454+00:00",
    "checkingInProgress": false
}

/customers/{customer}/spaces{space}/images/{image}/storage

MethodLabelExpectsReturnsStatus
GETRetrieve an ImageStorage object-vocab:ImageStorage200 OK, 404 Not Found

thumbnailSize

Storage space taken up by this item’s thumbnails, in bytes.

domainrangereadonlywriteonly
vocab:ImageStoragexsd:nonNegativeIntegerTrueFalse

size

Storage space taken up by the platform artifacts for this item, in bytes.

domainrangereadonlywriteonly
vocab:ImageStoragexsd:nonNegativeIntegerTrueFalse

lastChecked

When these figures were last computed.

domainrangereadonlywriteonly
vocab:ImageStoragexsd:dateTimeTrueFalse

checkingInProgress

If a computation of these figures is currently running.

domainrangereadonlywriteonly
vocab:ImageStoragexsd:dateTimeTrueFalse
touched 2025-09-23T12:04:54