Get server status | SFTPGo Octri Preview

6 status codes

200successful operation

allow_listobjectoptional

data_providerobjectoptional

defenderobjectoptional

ftpobjectoptional

mfaobjectoptional

rate_limitersobjectoptional

sshobjectoptional

webdavobjectoptional

400Bad Request

errorstringoptional

error description if any

messagestringoptional

message, can be empty

401Unauthorized

errorstringoptional

error description if any

messagestringoptional

message, can be empty

403Forbidden

errorstringoptional

error description if any

messagestringoptional

message, can be empty

500Internal Server Error

errorstringoptional

error description if any

messagestringoptional

message, can be empty

defaultUnexpected Error

errorstringoptional

error description if any

messagestringoptional

message, can be empty

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.

import { SFTPGoEnterpriseAPIUnofficialOctriFullPreview } from "sftpgo-octri-preview-sdk";

const client = new SFTPGoEnterpriseAPIUnofficialOctriFullPreview({
  baseUrl: "/api/v2",
  auth: { apiKeyAuth: process.env.API_TOKEN! },
});

const result = await client.maintenance.getStatus();

{
  "allow_list": {
    "is_active": true
  },
  "data_provider": {
    "driver": "example_value",
    "error": "example_value",
    "is_active": true
  },
  "defender": {
    "is_active": true
  },
  "ftp": {
    "bindings": [
      {
        "active_connections_security": "0",
        "address": "example_value",
        "apply_proxy_config": true,
        "client_auth_type": 1,
        "debug": true,
        "force_passive_ip": "example_value",
        "ignore_ascii_transfer_type": "0",
        "min_tls_version": "12",
        "passive_connections_security": "0",
        "passive_ip_overrides": [
          {
            "ip": "example_value",
            "networks": [
              null
            ]
          }
        ],
        "port": 1,
        "tls_cipher_suites": [
          "example_value"
        ],
        "tls_mode": "0"
      }
    ],
    "is_active": true,
    "passive_port_range": {
      "end": 1,
      "start": 1
    }
  },
  "mfa": {
    "is_active": true,
    "totp_configs": [
      {
        "algo": "sha1",
        "issuer": "example_value",
        "name": "Example Name"
      }
    ]
  },
  "rate_limiters": {
    "is_active": true,
    "protocols": [
      "SSH"
    ]
  },
  "ssh": {
    "authentications": [
      "publickey"
    ],
    "bindings": [
      {
        "address": "example_value",
        "apply_proxy_config": true,
        "port": 1
      }
    ],
    "ciphers": [
      "example_value"
    ],
    "host_keys": [
      {
        "algorithms": [
          "example_value"
        ],
        "fingerprint": "example_value",
        "path": "example_value"
      }
    ],
    "is_active": true,
    "kex_algorithms": [
      "example_value"
    ],
    "macs": [
      "example_value"
    ],
    "public_key_algorithms": [
      "example_key_abc123"
    ],
    "ssh_commands": [
      "example_value"
    ]
  },
  "webdav": {
    "bindings": [
      {
        "address": "example_value",
        "client_auth_type": 1,
        "enable_https": true,
        "min_tls_version": "12",
        "port": 1,
        "prefix": "example_value",
        "proxy_allowed": [
          "example_value"
        ],
        "tls_cipher_suites": [
          "example_value"
        ]
      }
    ],
    "is_active": true
  }
}

Response

Errors