---
title: "Get Settings"
method: GET
path: "/api/settings"
tags: ["Settings"]
---

# Get Settings

`GET /api/settings`

## Response `200`

Successful Response

- SettingsSchema
  - `telegram` Telegram
    - `enable` boolean
    - `token` string, nullable
    - `webhook_url` string, nullable
    - `webhook_secret` string, nullable
    - `proxy_url` string, nullable
    - `method` 'webhook' | 'long-polling'
    - `mini_app_login` boolean
    - `mini_app_web_url` string, nullable
    - `for_admins_only` boolean
  - `webhook` Webhook
    - `enable` boolean
    - `webhooks` WebhookInfo[]
      - `url` string, required
      - `secret` string, required
    - `days_left` integer[]
    - `usage_percent` integer[]
    - `timeout` integer, required
    - `recurrent` integer, required
    - `proxy_url` string, nullable
  - `notification_settings` NotificationSettings
    - `notify_telegram` boolean
    - `notify_discord` boolean
    - `telegram_api_token` string, nullable
    - `telegram_chat_id` integer, nullable
    - `telegram_topic_id` integer, nullable
    - `discord_webhook_url` string, nullable
    - `channels` NotificationChannels — Per-object notification channels
      - `admin` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `admin_role` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `core` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `group` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `host` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `node` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `user` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
      - `user_template` NotificationChannel — Channel configuration for sending notifications to a specific entity
        - `telegram_chat_id` integer, nullable
        - `telegram_topic_id` integer, nullable
        - `discord_webhook_url` string, nullable
    - `proxy_url` string, nullable
    - `max_retries` integer, required
  - `notification_enable` NotificationEnable
    - `admin` AdminNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
      - `reset_usage` boolean
      - `login` boolean
      - `usage_limit_warning` boolean
      - `usage_limit_warning_percentages` integer[]
    - `admin_role` BaseNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
    - `core` BaseNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
    - `group` BaseNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
    - `host` HostNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
      - `modify_hosts` boolean
    - `node` NodeNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
      - `connect` boolean
      - `error` boolean
      - `limited` boolean
      - `reset_usage` boolean
    - `user` UserNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
      - `status_change` boolean
      - `reset_data_usage` boolean
      - `data_reset_by_next` boolean
      - `subscription_revoked` boolean
    - `user_template` BaseNotificationEnable
      - `create` boolean
      - `modify` boolean
      - `delete` boolean
    - `days_left` boolean
    - `percentage_reached` boolean
  - `subscription` Subscription
    - `url_prefix` string
    - `update_interval` integer
    - `support_url` string
    - `profile_title` string
    - `announce` string
    - `announce_url` string
    - `response_headers` object
    - `rules` SubRule[], required
      - `pattern` string, required
      - `target` 'links' | 'links_base64' | 'xray' | 'wireguard' | 'sing_box' | 'clash' | 'clash_meta' | 'outline' | 'block', required
      - `response_headers` object
    - `manual_sub_request` SubFormatEnable
      - `links` boolean
      - `links_base64` boolean
      - `xray` boolean
      - `wireguard` boolean
      - `sing_box` boolean
      - `clash` boolean
      - `clash_meta` boolean
      - `outline` boolean
    - `applications` Application[]
      - `name` string, required
      - `icon_url` string
      - `import_url` string
      - `description` object
      - `recommended` boolean
      - `show_when_hwid_enabled` boolean
      - `platform` 'android' | 'ios' | 'windows' | 'macos' | 'linux' | 'appletv' | 'androidtv', required
      - `download_links` DownloadLink[], required
        - `name` string, required
        - `url` string, required
        - `language` 'fa' | 'en' | 'ru' | 'zh', required
    - `allow_browser_config` boolean
    - `disable_sub_template` boolean
    - `randomize_order` boolean
  - `hwid` HWIDSettings
    - `enabled` boolean
    - `forced` boolean
    - `require_hwid_for_manual_sub` boolean
    - `fallback_limit` integer, nullable
    - `min_limit` integer, nullable
    - `max_limit` integer, nullable
  - `general` General
    - `default_method` 'aes-128-gcm' | 'aes-256-gcm' | 'chacha20-ietf-poly1305' | 'xchacha20-poly1305'

## Other responses

- `401` — Unauthorized Error
- `403` — Forbidden Error

---

[API](https://skmtc.dev/ha-man2/apis/pasarguardapi.md) · [All operations](https://skmtc.dev/ha-man2/apis/pasarguardapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ha-man2/pasarguardapi/revisions/84d9ff88fcda/schema)