Sign in
Database Queries

Database connectivity probe (REST API)

Changed on

Connectivity probe that runs a fixed SELECT 1 through pgproxy, using the same authentication, status/bandwidth gating, and metering as the other /query/* endpoints.

Unlike those endpoints, ping takes no request body and performs no table-name validation, so it works on any database — including a freshly provisioned, empty one. It is a real committed round-trip through pgproxy, so a 200 means the database is reachable and queryable. Used by the dashboard's database connection test.

Branch-targeted. Runs against the named branch instead of the parent database, using the branch's own credentials. The branch must be active and unexpired. Nothing about this request can reach the parent's data.

post/databases/{databaseName}/branches/{branchName}/query/ping

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/databases/{databaseName}/branches/{branchName}/query/ping
  • Auth: HTTP bearer

Path parameters

databaseNamestring required

Database name (unique within project, lowercase letters, numbers, and underscores only)

branchNamestring required

Branch name (unique within the parent database, lowercase letters, numbers, and underscores only)

Response

Database is reachable

dataobject[]

Result rows

countinteger

Number of rows returned

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter branchName

    • ▲

      added the new path request parameter databaseName

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • c2ec82fb8ce8Revision changes
    • ○

      added the non-success response with the status