Database Queries

Delete data from database (REST API)

Changed on

Delete rows from your database using REST API.

Safety: Requires at least one filter to prevent accidental mass deletions

Security: Row-Level Security ensures you can only delete data you have access to

Note: If RLS blocks the delete, an empty result is returned (not an error)

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/delete

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/databases/{databaseName}/branches/{branchName}/query/delete
  • 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)

Request body

tablestring required

Table name

Example request

{
  "table": "posts",
  "filters": [
    {
      "column": "id",
      "operator": "eq",
      "value": "post-uuid"
    }
  ]
}

Response

Delete successful

dataobject[]

Result rows

countinteger

Number of rows returned

Changes

    • ▲

      added the new path request parameter branchName

    • ▲

      added the new path request parameter databaseName

    • ▲

      added the new required request property

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      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

    • ▲

      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 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

    • ○

      added the required property to the response with the status

    • ○

      added the non-success response with the status