Sign in
Tenants

Get tenant info

Changed on

Returns the operational state of the tenant: status, resource counts, and resource limits. Used by FilOne to render the dashboard quotas display and to read current status before deciding whether a status update is necessary.

get/tenants/{tenantId}

Request

  • Base URL: https://api.example.com
  • URL: https://api.example.com/tenants/{tenantId}
  • Auth: HTTP bearer

Response

Tenant info.

tenantIdstring uuid required

Client-supplied tenant identifier. Must be a UUID and must be unique within the partner. Used as the canonical ID in all calls ({tenantId} path parameter). FilOne supplies this value at tenant creation time via PUT /tenants/{tenantId}; the same value is the idempotency key for that operation.

status'active' | 'write-locked' | 'disabled' required
  • active — read/write
  • write-locked — read-only; uploads and bucket creation blocked
  • disabled — all access blocked, data persisted
bucketCountinteger required
bucketLimitinteger required

Maximum number of buckets the tenant may create.

accessKeyCountinteger required

Total number of S3 access keys for this tenant, including a per-tenant system key issued by FilOne for Console use. The Service Orchestrator does not need to treat the system key specially; it is counted alongside user-created keys.

accessKeyLimitinteger required

Maximum number of S3 access keys the tenant may hold.

createdAtstring date-time required

Changes