---
title: "List administrator-managed instance settings"
method: GET
path: "/admin/instance-settings"
tags: ["Admin"]
---

# List administrator-managed instance settings

`GET /admin/instance-settings`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/admin/instance-settings`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

Returns the typed optional configuration registry. Secrets are redacted. Administrator overrides take precedence over environment values after restart, while the configured environment source remains visible as the fallback.

## Response `200`

OK

- InstanceSettingsResponse
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `requires_restart` boolean, required: Whether any saved setting needs a server restart
  - `settings` InstanceSettingResponse[], nullable, required
    - `configured` boolean, required: Whether the desired value is non-empty
    - `database_override_configured` boolean, required: Whether an encrypted administrator override exists
    - `description` string, required: Setting purpose and effect
    - `editable` boolean, required: Whether the administrator can save an encrypted database override
    - `environment_variables` string[], nullable, required: Supported direct environment variable names
    - `group` string, required: Configuration group
    - `key` string, required: Canonical environment variable name
    - `label` string, required: Human-readable setting name
    - `managed_by` string: Direct or file-backed environment variable that supplies a configured value or fallback
    - `optional` boolean, required: Whether an empty value is valid
    - `options` InstanceSettingOptionResponse[], nullable: Allowed values for enum settings
      - `label` string, required: Human-readable option label
      - `value` string, required: Stored option value
    - `requires_restart` boolean, required: Whether the saved value differs from the running process
    - `secret` boolean, required: Whether the value is sensitive and always redacted
    - `secret_configured` boolean, required: Whether a redacted secret value is configured
    - `source` 'environment' | 'database' | 'default', required: Layer that supplies the desired value after administrator overrides are applied
    - `type` 'boolean' | 'integer' | 'string' | 'secret' | 'url' | 'email' | 'enum' | 'list', required: Input type
    - `updated_at` string: Last database update time
    - `value` string: Desired non-secret value. Secret values are never returned.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/openpo/apis/openpost-api.md) · [All operations](https://skmtc.dev/openpo/apis/openpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openpo/apis/openpost-api/revisions/67d3964458a7?raw)