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)

[
  {
    "name": "auth",
    "healthy": true,
    "status": "COMING_UP",
    "info": {
      "name": "GoTrue",
      "version": "lorem",
      "description": "lorem"
    },
    "error": "lorem"
  }
]