Admin Storage Usage

Generated admin storage usage operations.

GET/v1/admin/storage-usageRead server storage usageadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_storage_usage

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "artworkEncoding": [
      {
        "count": 0,
        "format": "2026-10-18T19:30:00Z",
        "outcome": "string",
        "slot": "string"
      }
    ],
    "categories": [
      {
        "bytes": 0,
        "bytesText": "string",
        "cleanable": true,
        "description": "string",
        "directories": [
          "string"
        ],
        "fileCount": 0,
        "id": "id_8h2k4q",
        "name": "Fargo",
        "oldestDays": 0,
        "paths": [
          "string"
        ],
        "present": true,
        "regenerable": true,
        "retentionKey": "string"
      }
    ],
    "observedAt": "2026-10-18T19:30:00Z",
    "stateDirectory": "string",
    "stateDirectoryOnNetwork": true,
    "totalBytes": 0,
    "totalBytesText": "string",
    "truncated": true
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- artworkEncodingarray of objectrequired
  - countintegerrequired
  - formatstringrequired
  - outcomestringrequired
  - slotstringrequired
- categoriesarray of objectrequired
  - bytesintegerrequired
  - bytesTextstringrequired
  - cleanablebooleanrequired
  - descriptionstringrequired
  - directoriesarray of stringrequired
  - fileCountintegerrequired
  - idstringrequired
  - namestringrequired
  - oldestDaysintegerrequired
  - pathsarray of stringrequired
  - presentbooleanrequired
  - regenerablebooleanrequired
  - retentionKeystringrequired
- observedAtstringrequired
- stateDirectorystringrequired
- stateDirectoryOnNetworkboolean
- totalBytesintegerrequired
- totalBytesTextstringrequired
- truncatedbooleanrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/storage-usage" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/storage-usage/{category}/cleanupRun server storage usage cleanupadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: post_admin_storage_usage_category_cleanup
Max body: 64 KiB

Parameters

Name	In	Type	Description
`category`required	path	`string`

Request body application/json · required

Example

{
  "confirmation": "string",
  "olderThanDays": 0,
  "operationId": "id_8h2k4q"
}

Schema

confirmationstringrequired
olderThanDaysintegerrequired
operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "bytesFreed": 0,
    "bytesFreedText": "string",
    "category": "string",
    "filesRemoved": 0,
    "olderThanDays": 0,
    "skipped": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- bytesFreedintegerrequired
- bytesFreedTextstringrequired
- categorystringrequired
- filesRemovedintegerrequired
- olderThanDaysintegerrequired
- skippedintegerrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/storage-usage/{category}/cleanup" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirmation":"string","olderThanDays":0,"operationId":"id_8h2k4q"}'