Skip to content
Management API Reference

[Beta] Gets the latest status of the project's upgrade

get/v1/projects/{ref}/upgrade/status

OAuth scopes

  • projects:read

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

  • project_admin_read
  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • tracking_id
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "databaseUpgradeStatus": {
    "initiated_at": "lorem",
    "latest_status_at": "lorem",
    "target_version": 42,
    "error": "1_upgraded_instance_launch_failed",
    "progress": "0_requested",
    "status": 42
  }
}