Skip to main content
GET
/
api
/
settings
/
tenant
/
usage
Read Tenant Usage
curl --request GET \
  --url https://api.example.com/api/settings/tenant/usage \
  --header 'Authorization: Bearer <token>'
{
  "total_scans": 0,
  "running_scans": 0,
  "queued_scans": 0,
  "total_datasets": 0,
  "total_storage_bytes": 0,
  "total_users": 0
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Cookies

antidote_session
string | null

Response

Successful Response

Current tenant resource usage.

total_scans
integer
default:0
running_scans
integer
default:0
queued_scans
integer
default:0
total_datasets
integer
default:0
total_storage_bytes
integer
default:0
total_users
integer
default:0