AssetQuota

Represents a quota for an asset-related action.

For example, a user might be able to upload 100 audio files per month and have uploaded 15 already. In this example:

  • quotaType is RATE_LIMIT_UPLOAD
  • assetType is AUDIO
  • usage is 15
  • capacity is 100
  • period is MONTH usageResetTime indicates when a new period begins and usage resets to 0. This value doesn't necessarily correlate with the first day of a calendar month or midnight on a given day. For more information on the upload process, see the usage guide.

Attributes

pathstring

The resource path of the asset quota.

Format: users/{user_id}/asset-quotas/{asset_quota_id}.

quotaTypeEnum<string>

Type of quota.

Possible values:

ValueDescription
QUOTA_TYPE_UNSPECIFIEDThe default quota type.
RATE_LIMIT_UPLOADRate limit on how often one can upload an asset.
RATE_LIMIT_CREATOR_STORE_DISTRIBUTERate limit on how often one can distribute an asset on the Creator Store.
assetTypeEnum<string>

The asset type the quota is for.

Possible values:

ValueDescription
ASSET_TYPE_UNSPECIFIEDThe default asset type.
IMAGEImage
TSHIRTTshirt
AUDIOAudio
MESHMesh
LUALua
HATHat
PLACEPlace
MODELModel
SHIRTClassic Shirt
PANTSClassic Pants
DECALDecal
HEADHead
FACEFace
GEARGear
ANIMATIONAnimation
TORSOTorso
RIGHT_ARMRight Arm
LEFT_ARMLeft Arm
LEFT_LEGLeft Leg
RIGHT_LEGRight Leg
YOUTUBE_VIDEOYouTube Video
APPApp
CODECode
PLUGINPlugin
SOLID_MODELSolid Model
MESH_PARTMesh Part
HAIR_ACCESSORYHair Accessory
FACE_ACCESSORYFace Accessory
NECK_ACCESSORYNeck Accessory
SHOULDER_ACCESSORYShoulder Accessory
FRONT_ACCESSORYFront Accessory
BACK_ACCESSORYBack Accessory
WAIST_ACCESSORYWaist Accessory
CLIMB_ANIMATIONClimb Animation
DEATH_ANIMATIONDeath Animation
FALL_ANIMATIONFall Animation
IDLE_ANIMATIONIdle Animation
JUMP_ANIMATIONJump Animation
RUN_ANIMATIONRun Animation
SWIM_ANIMATIONSwim Animation
WALK_ANIMATIONWalk Animation
POSE_ANIMATIONPose Animation
LOCALIZATION_TABLE_MANIFESTLocalization Table Manifest
LOCALIZATION_TABLE_TRANSLATIONLocalization Table Translation
EMOTE_ANIMATIONEmote Animation
VIDEOVideo
TEXTURE_PACKTexture Pack
TSHIRT_ACCESSORYTshirt Accessory
SHIRT_ACCESSORYShirt Accessory
PANTS_ACCESSORYPants Accessory
JACKET_ACCESSORYJacket Accessory
SWEATER_ACCESSORYSweater Accessory
SHORTS_ACCESSORYShorts Accessory
LEFT_SHOE_ACCESSORYLeft Shoe Accessory
RIGHT_SHOE_ACCESSORYRight Shoe Accessory
DRESS_SKIRT_ACCESSORYDress Skirt Accessory
FONT_FAMILYFont Family
FONT_FACEFont Face
MESH_HIDDEN_SURFACE_REMOVALMesh Hidden Surface Removal
EYEBROW_ACCESSORYEyebrow Accessory
EYELASH_ACCESSORYEyelash Accessory
MOOD_ANIMATIONMood Animation
DYNAMIC_HEADDynamic Head
CODE_SNIPPETCode Snippet
ADS_VIDEOAds Video
usagenumber

The current usage of the quota.

capacitynumber

The capacity of the quota.

periodEnum<string>

The period of time the quota is for.

Possible values:

ValueDescription
PERIOD_UNSPECIFIEDThe default period, which is invalid. Specify another value.
MONTHMonth
DAYDay
usageResetTimestring

The time the usage will reset for this quota. This string is formatted as a Timestamp.

Base URL
https://apis.roblox.com
The AssetQuota Resource
{

  "path": "users/123/asset-quotas/some-asset-quota",

  "quotaType": "QUOTA_TYPE_UNSPECIFIED",

  "assetType": "ASSET_TYPE_UNSPECIFIED",

  "usage": "integer",

  "capacity": "integer",

  "period": "PERIOD_UNSPECIFIED",

  "usageResetTime": "2023-07-05T12:34:56Z"

}

AssetQuota

List Asset Quotas
Beta

GET /cloud/v2/users/{user_id}/asset-quotas

Returns a list of asset quotas.

Scopes
asset:read
RequestPath Parameters
user_idstring
Required

The user ID.

Query Parameters
maxPageSizenumber

The maximum number of asset quotas to return. The service might return fewer than this value. If unspecified, at most 10 asset quotas are returned. The maximum value is 100 and higher values are set to 100.

pageTokenstring

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.

filterstring

This field may be set in order to filter the resources returned.

Supports the following subset of CEL:

  • Only the quotaType and assetType fields are supported.
  • Only the == and && operator are supported.

For example: quotaType == RateLimitUpload && assetType == Audio.

Response

A list of AssetQuotas in the parent collection.

assetQuotasarray<AssetQuota>

The AssetQuotas from the specified User.

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

GET /cloud/v2/users/{user_id}/asset-quotas
curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}/asset-quotas?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "assetQuotas": [

    {

      "path": "users/123/asset-quotas/some-asset-quota",

      "quotaType": "QUOTA_TYPE_UNSPECIFIED",

      "assetType": "ASSET_TYPE_UNSPECIFIED",

      "usage": "integer",

      "capacity": "integer",

      "period": "PERIOD_UNSPECIFIED",

      "usageResetTime": "2023-07-05T12:34:56Z"

    }

  ],

  "nextPageToken": "string"

}