Skip to content
Management API Reference

[Beta] Returns the project's eligibility for upgrades

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

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

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"eligible": true,
"current_app_version": "lorem",
"current_app_version_release_channel": "internal",
"latest_app_version": "lorem",
"target_upgrade_versions": [
{
"postgres_version": "13",
"release_channel": "internal",
"app_version": "lorem"
}
],
"duration_estimate_hours": 42,
"legacy_auth_custom_roles": [
"lorem"
],
"objects_to_be_dropped": [
"lorem"
],
"unsupported_extensions": [
"lorem"
],
"user_defined_objects_in_internal_schemas": [
"lorem"
],
"validation_errors": [
{
"type": "objects_depending_on_pg_cron",
"dependents": [
"lorem"
]
}
],
"warnings": [
{
"type": "pg_graphql_introspection_change"
}
]
}