---
title: "Get the server settings."
method: GET
path: "/settings.json"
tags: ["Settings"]
---

# Get the server settings.

`GET /settings.json`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/settings.json`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/settings.json/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Operation is successful

- object
  - `header` Header, required
    - `id` string, uuid, required
    - `status` 'success' | 'error', required
    - `servertime` integer, required
    - `action` string, uuid, required
    - `message` string, required
    - `url` string, uri, required
    - `code` integer, required
  - `body` Index, required
    - `app` object, required
      - `url` string
      - `locale` string
    - `passbolt` object, required
      - `legal` object
        - `privacy_policy` object
          - `url` string
        - `terms` object
          - `url` string
      - `edition` string
      - `plugins` object
        - `jwtAuthentication` object
          - `enabled` boolean
        - `accountRecoveryRequestHelp` object
          - `enabled` boolean
        - `accountRecovery` object
          - `enabled` boolean
        - `selfRegistration` object
          - `enabled` boolean
        - `sso` object
          - `enabled` boolean
        - `mfaPolicies` object
          - `enabled` boolean
        - `ssoRecover` object
          - `enabled` boolean
        - `userPassphrasePolicies` object
          - `enabled` boolean
        - `inFormIntegration` object
          - `enabled` boolean
        - `metadata` object
          - `version` string
          - `enabled` boolean
        - `locale` object
          - `options` object[]
            - `locale` string
            - `label` string
        - `rememberMe` object
          - `options` object
            - `300` string
            - `900` string
            - `1800` string
            - `3600` string
            - `-1` string

## Other responses

- `400`: Bad request
- `401`: Authentication required.

## Changes

- **2025-06-25** `829cf48ab700`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/passbolt/apis/passbolt-api/changes/settings.json/get.md)

---

[API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)