---
title: "Get healthcheck information."
method: GET
path: "/healthcheck.json"
tags: ["Healthcheck"]
---

# Get healthcheck information.

`GET /healthcheck.json`

## Request

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

Only administrators can query this endpoint.

## 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` Healthcheck, required
    - `environment` object, required
      - `gnupg` boolean, required
      - `info` object, required
        - `phpVersion` string, required
      - `phpVersion` boolean, required
      - `nextMinPhpVersion` boolean, required
      - `pcre` boolean, required
      - `mbstring` boolean, required
      - `intl` boolean, required
      - `image` boolean, required
      - `tmpWritable` boolean, required
      - `logWritable` boolean, required
    - `configFile` object, required
      - `app` boolean, required
      - `passbolt` boolean, required
    - `core` object, required
      - `cache` boolean, required
      - `debugDisabled` boolean, required
      - `salt` boolean, required
      - `info` object, required
        - `fullBaseUrl` string, required
      - `fullBaseUrl` boolean, required
      - `validFullBaseUrl` boolean, required
      - `fullBaseUrlReachable` boolean, required
    - `ssl` object, required
      - `info` string, required
      - `peerValid` boolean, required
      - `hostValid` boolean, required
      - `notSelfSigned` boolean, required
    - `smtpSettings` object, required
      - `isEnabled` boolean, required
      - `errorMessage` boolean, required
      - `source` string, required
      - `isInDb` boolean, required
      - `areEndpointsDisabled` boolean, required
      - `customSslOptions` boolean, required
    - `gpg` object, required
      - `lib` boolean, required
      - `gpgHome` boolean, required
      - `gpgHomeWritable` boolean, required
      - `gpgKeyPublicBlock` boolean, required
      - `gpgKeyPrivateBlock` boolean, required
      - `gpgKeyPublicReadable` boolean, required
      - `gpgKeyPrivateReadable` boolean, required
      - `gpgKeyPrivateFingerprint` boolean, required
      - `gpgKeyPublic` boolean, required
      - `gpgKeyPrivate` boolean, required
      - `gpgKey` boolean, required
      - `info` object, required
        - `gpgKeyPrivate` string, required
        - `gpgHome` string, required
      - `gpgKeyPublicFingerprint` boolean, required
      - `gpgKeyPublicInKeyring` boolean, required
      - `gpgKeyPublicEmail` boolean, required
      - `canEncrypt` boolean, required
      - `canSign` boolean, required
      - `canEncryptSign` boolean, required
      - `canDecrypt` boolean, required
      - `canDecryptVerify` boolean, required
      - `canVerify` boolean, required
      - `isPublicServerKeyGopengpgCompatible` boolean, required
      - `isPrivateServerKeyGopengpgCompatible` boolean, required
    - `application` object, required
      - `configPath` string, required
      - `info` object, required
        - `remoteVersion` string, required
        - `currentVersion` string, required
      - `latestVersion` boolean, required
      - `sslForce` boolean, required
      - `sslFullBaseUrl` boolean, required
      - `seleniumDisabled` boolean, required
      - `robotsIndexDisabled` boolean, required
      - `registrationClosed` object, required
        - `isSelfRegistrationPluginEnabled` boolean, required
        - `selfRegistrationProvider` string, required
        - `isRegistrationPublicRemovedFromPassbolt` boolean, required
      - `hostAvailabilityCheckEnabled` boolean, required
      - `jsProd` boolean, required
      - `emailNotificationEnabled` boolean, required
      - `schema` boolean, required
    - `database` object, required
      - `supportedBackend` boolean, required
      - `connect` boolean, required
      - `info` object, required
        - `tablesCount` integer, required
      - `tablesCount` boolean, required
      - `defaultContent` boolean, required

## Other responses

- `403`: Authentication required.

---

[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)