---
title: "Get status"
method: GET
path: "/status"
tags: ["maintenance"]
---

# Get status

`GET /status`

Retrieves the status of the active services

## Response `200`

successful operation

- ServicesStatus
  - `ssh` SSHServiceStatus
    - `is_active` boolean
    - `bindings` SSHBinding[], nullable
      - `address` string — TCP address the server listen on
      - `port` integer — the port used for serving requests
      - `apply_proxy_config` boolean — apply the proxy configuration, if any
    - `host_keys` SSHHostKey[], nullable
      - `path` string
      - `fingerprint` string
      - `algorithms` string[]
    - `ssh_commands` string[]
    - `authentications` SSHAuthentications[]
    - `public_key_algorithms` string[]
    - `macs` string[]
    - `kex_algorithms` string[]
    - `ciphers` string[]
  - `ftp` FTPServiceStatus
    - `is_active` boolean
    - `bindings` FTPDBinding[], nullable
      - `address` string — TCP address the server listen on
      - `port` integer — the port used for serving requests
      - `apply_proxy_config` boolean — apply the proxy configuration, if any
      - `tls_mode` 0 | 1 | 2 — TLS mode: * `0` - clear or explicit TLS * `1` - explicit TLS required * `2` - implicit TLS
      - `min_tls_version` 12 | 13 — TLS version: * `12` - TLS 1.2 * `13` - TLS 1.3
      - `force_passive_ip` string — External IP address for passive connections
      - `passive_ip_overrides` PassiveIPOverride[]
        - `networks` string[]
        - `ip` string
      - `client_auth_type` integer — 1 means that client certificate authentication is required in addition to FTP authentication
      - `tls_cipher_suites` string[] — List of supported cipher suites for TLS version 1.2. If empty a default list of secure cipher suites is used, with a preference order based on hardware performance
      - `passive_connections_security` 0 | 1 — Active connections security: * `0` - require matching peer IP addresses of control and data connection * `1` - disable any checks
      - `active_connections_security` 0 | 1 — Active connections security: * `0` - require matching peer IP addresses of control and data connection * `1` - disable any checks
      - `ignore_ascii_transfer_type` 0 | 1 — Ignore client requests to perform ASCII translations: * `0` - ASCII translations are enabled * `1` - ASCII translations are silently ignored
      - `debug` boolean — If enabled any FTP command will be logged
    - `passive_port_range` FTPPassivePortRange
      - `start` integer
      - `end` integer
  - `webdav` WebDAVServiceStatus
    - `is_active` boolean
    - `bindings` WebDAVBinding[], nullable
      - `address` string — TCP address the server listen on
      - `port` integer — the port used for serving requests
      - `enable_https` boolean
      - `min_tls_version` 12 | 13 — TLS version: * `12` - TLS 1.2 * `13` - TLS 1.3
      - `client_auth_type` integer — 1 means that client certificate authentication is required in addition to HTTP basic authentication
      - `tls_cipher_suites` string[] — List of supported cipher suites for TLS version 1.2. If empty a default list of secure cipher suites is used, with a preference order based on hardware performance
      - `prefix` string — Prefix for WebDAV resources, if empty WebDAV resources will be available at the `/` URI
      - `proxy_allowed` string[] — List of IP addresses and IP ranges allowed to set proxy headers
  - `data_provider` DataProviderStatus
    - `is_active` boolean
    - `driver` string
    - `error` string
  - `defender` object
    - `is_active` boolean
  - `mfa` MFAStatus
    - `is_active` boolean
    - `totp_configs` TOTPConfig[]
      - `name` string
      - `issuer` string
      - `algo` 'sha1' | 'sha256' | 'sha512' — Supported HMAC algorithms for Time-based one time passwords
  - `allow_list` object
    - `is_active` boolean
  - `rate_limiters` object
    - `is_active` boolean
    - `protocols` string[]

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `default` — Unexpected Error

---

[API](https://skmtc.net/kanton-bern/apis/sftpgo.md) · [All operations](https://skmtc.net/kanton-bern/apis/sftpgo/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kanton-bern/sftpgo/revisions/d8d616a479b0/schema)