Sign in
Tenants

Create and set up a tenant

Changed on

Provisions a tenant and runs all setup steps synchronously. The response is returned only after the tenant is fully operational — the S3 gateway accepts traffic and access-key issuance is available.

Idempotent on tenantId: a second call with the same identifier returns the existing tenant rather than failing. The tenantId is supplied by FilOne (a UUID) in the URL path and reused as the {tenantId} path parameter in all subsequent calls.

put/tenants/{tenantId}

Request

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

Request body

regionstring required

Region identifier the tenant's data is provisioned in — the same region name used in the S3 Gateway hostname (https://s3.{region}.filonecontent.com), e.g. us-east-1. A Service Orchestrator may manage more than one region; it must reject (422) region values it does not serve.

Response

Tenant already existed (idempotent re-call).

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

  • 306f4c78a6fdRevision changes
    • breaking

      added the new required request property

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

  • 3d43bb73d271Revision changes
    • info

      endpoint added