Document toolboxDocument toolbox

REST API - Space Quota

Introduction

The space quota data can be retrieved and quota allocated can be updated via REST API:

acc space quota.png

 

REST APIs

Method

GET

URL

/rest/attachment-checker/1.0/space/quota

Query params

startIndex - The start index e.g. start=0

Response

200

{ "total": 45, "spaceQuotaList": [ { "spaceKey": "ACC", "quotaUnit": "MB", "quotaAllocated": "5.00", "quotaUsed": "0.99", "quotaAvailable": "4.01", "quotaUsage": "19.8", "quotaUsageColour": "green", "isQuotaDefault": true, "isQuotaUnlimited": false, "allVersionsCount": 19, "currentVersionsCount": 12, "lastUpdateTime": "Aug 01, 2024 05:00", "nextUpdateTime": "Aug 16, 2024 05:00", "isAddedToQueue": false }, ... ] }

403 - No view permission

You do not have permission to view this.

412 - Quota setup not completed

The Space Quota is not viewable yet. Please look for your Confluence Administrator to complete the initial setup.

Permission

Available for:

  • Confluence admins

Method

GET

URL

/rest/attachment-checker/1.0/space/{spaceKey}/quota

Path params

spaceKey - The space key

Response

200

403 - No view permission

412 - Quota setup not completed

Permission

Available for:

  • Confluence admins

  • Space admins

  • Space users if Allow users to view space quota permission is enabled

Method

POST

URL

/rest/attachment-checker/1.0/space/{spaceKey}/quota?quotaAllocated=

Path params

spaceKey - The space key

Query param

quotaAllocated - The new quota to set for the space e.g. quotaAllocated=5.00

Response

200

403 - No edit permission

412 - Quota setup not completed

Permission

Available for:

  • Confluence admins