Skip to content

Returns project's readonly mode status

get/v1/projects/{ref}/readonly

OAuth scopes

  • database:read

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

  • database_readonly_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "enabled": true,
  "override_enabled": true,
  "override_active_until": "lorem"
}
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "override_enabled": {
      "type": "boolean"
    },
    "override_active_until": {
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "override_enabled",
    "override_active_until"
  ]
}