Skip to main content

GetWorkspaceUsage

Get workspace usage

Description​

Obtains information on the usage status (users, database, storage) of the specified workspace.

Method​

GET

Request URL Format​

/api/v0/workspaces/:workspace-id/usages

URL Params​

workspace-id Specifies the workspace ID to be acquired

Query Params​

None

Request URL Sample​

GET https://api.xxx.com/api/v0/workspaces/58ca3597cce5fe3ea0a42fa8/usages

Response Sample​

{
    "w_id": "5fca3878aa39557110839cfc", // Workspace ID
    "usage": {
        "users": 1, // Current number of users
        "users_limit": 300, // Number of available users
        "storage": 0,　// Current storage capacity used
        "storage_limit": 500, // Available storage capacity
        "datastores": 34, // Number of databases currently in use
        "datastores_limit": 50, // Maximum number of databases available
        "items": 0, // Number of registered items (*Note: Not available as of March 2021)
        "items_limit": 0　// Maximum number of items that can be registered (*Note: Not in use as of March 2021)
    }
}