Skip to content
Management API Reference

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

  • 200
  • 401
  • 403
  • 429
  • 500

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
]