Get state of the server and its dependencies.

GET

/health

const url = 'http://localhost:8080/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/health

Responses

200

application/json

object

dependencies

Array<object>

The state of a registered server dependency.

object

message

Human-readable message for explaining the current state.

string

service

string

status

string

name

required

string

version

required

The Connect server’s version

string

Examples

WaitingForAPIRequest

API server waiting for first authenticated request

{
  "dependencies": [
    {
      "service": "sync",
      "status": "TOKEN_NEEDED"
    },
    {
      "message": "Connected to./1password.sqlite",
      "service": "sqlite",
      "status": "ACTIVE"
    }
  ],
  "name": "1Password Connect API",
  "version": "1.2.1"
}