Skip to content

Storage API

Get an FID's storage limits.

API

Method NameRequest TypeResponse TypeDescription
GetCurrentStorageLimitsByFidFidRequestStorageLimitsResponseReturns current storage limits for all stores for an Fid

StorageLimitsResponse

FieldTypeLabelDescription
limitsStorageLimitrepeatedStorage limits per store type
unitsuint32Number of units
unit_detailsStorageUnitDetailsrepeatedDetails about storage units
tier_subscriptionsTierDetailsrepeatedTier subscription details

StorageLimit

FieldTypeLabelDescription
store_typeStoreTypeThe specific type being managed by the store
namestringName of the store type
limituint64The limit of the store type, scaled by the user's rent
useduint64Current usage of the store type
earliestTimestampuint64Timestamp of earliest message
earliestHashbytesHash of earliest message

StorageUnitDetails

FieldTypeLabelDescription
unit_typeStorageUnitTypeType of storage unit
unit_sizeuint32Size of the storage unit

TierDetails

FieldTypeLabelDescription
tier_typeTierTypeType of tier
expires_atuint64Expiration timestamp