Gets project's service health status

get/v1/projects/{ref}/health

OAuth scopes

projects:read

The fine-grained token must include the following permissions to access this endpoint:

project_admin_read

Path parameters

ref
Required
string
Project ref

Query parameters

services
Required
any of the following options
Comma-separated list of enums or array of enums.
timeout_ms
Optional
integer

Response codes

Response (200)

1
[
2
  {
3
    "name": "auth",
4
    "healthy": true,
5
    "status": "COMING_UP",
6
    "info": {
7
      "name": "GoTrue",
8
      "version": "lorem",
9
      "description": "lorem"
10
    },
11
    "error": "lorem"
12
  }
13
]

1
{
2
  "type": "array",
3
  "items": {
4
    "type": "object",
5
    "properties": {
6
      "name": {
7
        "type": "string",
8
        "enum": [
9
          "auth",
10
          "db",
11
          "db_postgres_user",
12
          "pooler",
13
          "realtime",
14
          "rest",
15
          "storage",
16
          "pg_bouncer"
17
        ]
18
      },
19
      "healthy": {
20
        "type": "boolean",
21
        "deprecated": true,
22
        "description": "Deprecated. Use `status` instead."
23
      },
24
      "status": {
25
        "type": "string",
26
        "enum": [
27
          "COMING_UP",
28
          "ACTIVE_HEALTHY",
29
          "UNHEALTHY"
30
        ]
31
      },
32
      "info": {
33
        "anyOf": [
34
          {
35
            "type": "object",
36
            "properties": {
37
              "name": {
38
                "type": "string",
39
                "enum": [
40
                  "GoTrue"
41
                ]
42
              },
43
              "version": {
44
                "type": "string"
45
              },
46
              "description": {
47
                "type": "string"
48
              }
49
            },
50
            "required": [
51
              "name",
52
              "version",
53
              "description"
54
            ]
55
          },
56
          {
57
            "type": "object",
58
            "properties": {
59
              "healthy": {
60
                "type": "boolean",
61
                "deprecated": true,
62
                "description": "Deprecated. Use `status` instead."
63
              },
64
              "db_connected": {
65
                "type": "boolean"
66
              },
67
              "replication_connected": {
68
                "type": "boolean"
69
              },
70
              "connected_cluster": {
71
                "type": "integer",
72
                "minimum": -9007199254740991,
73
                "maximum": 9007199254740991
74
              }
75
            },
76
            "required": [
77
              "healthy",
78
              "db_connected",
79
              "replication_connected",
80
              "connected_cluster"
81
            ]
82
          },
83
          {
84
            "type": "object",
85
            "properties": {
86
              "db_schema": {
87
                "type": "string"
88
              }
89
            },
90
            "required": [
91
              "db_schema"
92
            ]
93
          }
94
        ]
95
      },
96
      "error": {
97
        "type": "string"
98
      }
99
    },
100
    "required": [
101
      "name",
102
      "healthy",
103
      "status"
104
    ]
105
  }
106
}