schema

Create a new tenant

Creates one or more new tenants for a specified collection (className). Multi-tenancy must be enabled for the collection via its definition.

post/schema/{className}/tenants

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/tenants
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

classNamestring required

The name of the multi-tenant enabled collection (class).

Request body

namestring

The name of the tenant (required).

activityStatus'ACTIVE' | 'INACTIVE' | 'OFFLOADED' | 'OFFLOADING' | 'ONLOADING' | 'HOT' | 'COLD' | 'FROZEN' | 'FREEZING' | 'UNFREEZING'

The activity status of the tenant, which determines if it is queryable and where its data is stored.

<b>Available Statuses:</b>

  • ACTIVE: The tenant is fully operational and ready for queries. Data is stored on local, hot storage.
  • INACTIVE: The tenant is not queryable. Data is stored locally.
  • OFFLOADED: The tenant is inactive and its data is stored in a remote cloud backend.

<b>Usage Rules:</b>

  • <b>On Create:</b> This field is optional and defaults to ACTIVE. Allowed values are ACTIVE and INACTIVE.
  • <b>On Update:</b> This field is required. Allowed values are ACTIVE, INACTIVE, and OFFLOADED.

<b>Read-Only Statuses:</b> The following statuses are set by the server and indicate a tenant is transitioning between states:

  • OFFLOADING
  • ONLOADING

<b>Note on Deprecated Names:</b> For backward compatibility, deprecated names are still accepted and are mapped to their modern equivalents: HOT (now ACTIVE), COLD (now INACTIVE), FROZEN (now OFFLOADED), FREEZING (now OFFLOADING), UNFREEZING (now ONLOADING).

Response

Tenants created successfully.

namestring

The name of the tenant (required).

activityStatus'ACTIVE' | 'INACTIVE' | 'OFFLOADED' | 'OFFLOADING' | 'ONLOADING' | 'HOT' | 'COLD' | 'FROZEN' | 'FREEZING' | 'UNFREEZING'

The activity status of the tenant, which determines if it is queryable and where its data is stored.

<b>Available Statuses:</b>

  • ACTIVE: The tenant is fully operational and ready for queries. Data is stored on local, hot storage.
  • INACTIVE: The tenant is not queryable. Data is stored locally.
  • OFFLOADED: The tenant is inactive and its data is stored in a remote cloud backend.

<b>Usage Rules:</b>

  • <b>On Create:</b> This field is optional and defaults to ACTIVE. Allowed values are ACTIVE and INACTIVE.
  • <b>On Update:</b> This field is required. Allowed values are ACTIVE, INACTIVE, and OFFLOADED.

<b>Read-Only Statuses:</b> The following statuses are set by the server and indicate a tenant is transitioning between states:

  • OFFLOADING
  • ONLOADING

<b>Note on Deprecated Names:</b> For backward compatibility, deprecated names are still accepted and are mapped to their modern equivalents: HOT (now ACTIVE), COLD (now INACTIVE), FROZEN (now OFFLOADED), FREEZING (now OFFLOADING), UNFREEZING (now ONLOADING).

Changes

No recorded changes to this operation across all 1 revision of this API.