Skip to main content

Get All Tenants

GET 

/tenants

Get All Tenants

Responses‚Äč

A list of provisioned tenants with their configurations

Schema
  • Array [
  • id stringrequired
    name stringrequired

    The tenant name. It should match the pattern ^[a-z-]+$.

    base_url string

    The SDP backend server's base URL.

    sdp_ui_base_url string

    The SDP UI/dashboard Base URL.

    status stringrequired

    Possible values: [TENANT_CREATED, TENANT_PROVISIONED, TENANT_ACTIVATED, TENANT_DEACTIVATED]

    distribution_account_address string

    The Stellar account address used for distributing funds.

    distribution_account_type string

    Possible values: [ENV_STELLAR, DB_VAULT_STELLAR]

    The Stellar account type used for distributing funds.

    distribution_account_status string

    Possible values: [ACTIVE, PENDING_USER_ACTIVATION]

    The status of the distribution account used for distributing funds.

    is_default boolean

    Boolean flag that shows whether the tenant is the default or not.

    created_at date-timerequired
    updated_at date-timerequired
    deleted_at date-time

    The timestamp when the tenant was (soft) deleted.

  • ]
Loading...