Skip to main content
GET
Get deployment with settings
curl --request GET \
  --url https://api.wacht.dev/ \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "maintenance_mode": true,
  "backend_host": "<string>",
  "frontend_host": "<string>",
  "mail_from_host": "<string>",
  "publishable_key": "<string>",
  "mode": "production",
  "auth_settings": {
    "email": {},
    "phone": {},
    "username": {},
    "password": {},
    "name": {},
    "authentication_factors": {},
    "second_factor_policy": "<string>",
    "first_factor": "<string>",
    "backup_code": {},
    "web3_wallet": {},
    "multi_session_support": "<string>",
    "session_token_lifetime": 123,
    "session_validity_period": 123,
    "session_inactive_timeout": 123
  },
  "ui_settings": {
    "app_name": "<string>",
    "logo_image_url": "<string>",
    "favicon_image_url": "<string>",
    "primary_color": "<string>"
  },
  "b2b_settings": {
    "organizations_enabled": true,
    "workspaces_enabled": true
  },
  "restrictions": {
    "allowlist_enabled": true,
    "blocklist_enabled": true,
    "country_restrictions": {
      "mode": "allowlist",
      "allowed_country_codes": [
        "<string>"
      ],
      "blocked_country_codes": [
        "<string>"
      ]
    },
    "sign_up_mode": "<string>"
  },
  "email_provider": "postmark",
  "custom_smtp_config": {
    "host": "<string>",
    "port": 123,
    "username": "<string>",
    "from_email": "<string>",
    "use_tls": true,
    "verified": true
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication (format: Bearer {api_key})

Response

200 - application/json

Deployment with settings

​
id
string

Deployment ID

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
maintenance_mode
boolean
​
backend_host
string
​
frontend_host
string
​
mail_from_host
string
​
publishable_key
string
​
mode
enum<string>
Available options:
production,
staging
​
auth_settings
object
​
ui_settings
object
​
b2b_settings
object
​
restrictions
object
​
email_provider
enum<string>
Available options:
postmark,
custom_smtp
​
custom_smtp_config
object