View effective server configuration (admin only)

GET

/api/admin/config

curl --request GET \
  --url https://example.com/api/admin/config \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>'

Returns every key of the server’s effective configuration, grouped by top-level section, with secrets redacted (CA key, HSM PIN, client secret, cookie signing key, database connection string, LDAP bind password, SMTP password). A redacted key still reports whether a value is set. Useful for debugging and audit trails.

Authorizations

• sessionCookie

Responses

200

Current effective configuration

Media typeapplication/json

object

sections

required

Array<object>

object

name

required

Name is the top-level key the section covers (“http”, “cert_options”), or “server” for the switches that sit at the root of the file.

string

settings

required

Settings are the section’s leaves, in the order they are declared.

Array<object>

object

key

required

Key is the dotted configuration key, e.g. “http.tls.min_version” — the path an operator would write in their own config file, so a value on this screen can be traced back to the line that set it.

string

secret

Secret marks a key whose value is never sent. Value is the redaction placeholder when a secret is configured and empty when none is, so an operator can still tell whether one is set.

boolean

value

Value is what is in effect, rendered as text. Empty means unset: an empty string, a nil pointer, or an empty list or map.

string

Example ^generated

{
  "sections": [
    {
      "name": "example",
      "settings": [
        {
          "key": "example",
          "secret": true,
          "value": "example"
        }
      ]
    }
  ]
}

401

Not authenticated

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

403

Not an admin

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}