PorticoDocs

Admin Storage

Generated admin storage operations.

POST/v1/admin/storage/cache/emptyEmpty rebuildable cache on a graceful server restartadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
post_empty_data_cache

Responses

202Successapplication/json

Example
{
  "scheduled": true
}
Schema
  • scheduledbooleanrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittednot_foundinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/storage/cache/empty" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/admin/storage/statusRead active storage destinations and reclaimable database spaceadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
get_storage_status

Responses

200Successapplication/json

Example
{
  "backupDirectory": "string",
  "cacheDirectory": "string",
  "databasePath": "string",
  "lastReclaimedAt": "2026-10-18T19:30:00Z",
  "lastReclaimedBytes": 0,
  "reclaimableBytes": 0
}
Schema
  • backupDirectorystringrequired
  • cacheDirectorystringrequired
  • databasePathstringrequired
  • lastReclaimedAtstring
  • lastReclaimedBytesintegerrequired
  • reclaimableBytesintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternaltimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/storage/status" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/admin/storage/usageRead data folder usage and storage noticesadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
get_data_storage_usage

Responses

200Successapplication/json

Example
{
  "dataDirectory": "string",
  "folders": [
    {
      "bytes": 0,
      "name": "Fargo"
    }
  ],
  "notices": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "transcodeBytes": 0,
  "transcodeDirectory": "string"
}
Schema
  • dataDirectorystringrequired
  • foldersarray of objectrequired
    • bytesintegerrequired
    • namestringrequired
  • noticesarray of objectrequired
    • codestringrequired
    • messagestringrequired
  • transcodeBytesintegerrequired
  • transcodeDirectorystringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittednot_foundinternaltimeoutdatabase_busy

Example request

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