Get Platform Settings

Returns the platform-wide settings. Any API key with the permission may read them; they are platform configuration, not node data. Only platform_owner_can_change_wallet can be changed through this API, see Update Platform Owner Can Change Wallet.

Required permission: platform-setting:view

Request

GET /v2/admin/platform-settings

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/platform-settings' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "on_premise": false,
  "platform_owner_can_change_wallet": true,
  "is_self_custody_wallet": false,
  "distribution_market_id": null
}

Response Fields

Field	Type	Description
on_premise	boolean	Whether the platform runs on-premise (no licensor above the platform). Read-only here.
platform_owner_can_change_wallet	boolean	Whether the platform owner may change its own wallet on setups created from now on. Each setup keeps the value it was created with, and Start Platform Owner Change checks the setup's copy.
is_self_custody_wallet	boolean	End-user wallet mode: true means users bring their own external wallets, false means the platform manages custody wallets for them. Read-only here.
distribution_market_id	string | null	The configured distribution market id, or null when none is set. Read-only here.

Errors

Status	Code	Description
400	10015	The platform settings have not been created yet

See Errors for the error format and common codes.