Skip to navigation
API ReferenceDatabases

Delete rows from database table

Beta

Delete rows matching the filter conditions. Filter conditions are passed as query parameters using PostgREST syntax.

Filter Syntax:

  • ?column=eq.value - Equal
  • ?column=neq.value - Not equal
  • ?column=gt.value - Greater than
  • ?column=gte.value - Greater than or equal
  • ?column=lt.value - Less than
  • ?column=lte.value - Less than or equal
  • ?column=like.*pattern* - LIKE (case-sensitive)
  • ?column=ilike.*pattern* - ILIKE (case-insensitive)
  • ?column=in.(a,b,c) - IN list
  • ?column=is.null - IS NULL

Safety: Filters are required by default to prevent accidental bulk deletes. To delete all rows intentionally, pass ?force=true.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
table_namestringRequired

Headers

X-Athena-Session-CredentialstringOptional

Query parameters

forcebooleanOptionalDefaults to false

Set to true to delete all rows (required when no filters provided)

Request

This endpoint expects a nullable object.
return_representationbooleanOptionalDefaults to false
If true, return the deleted rows in the response

Response

Successful Response
datalist of maps from strings to any or nullOptional

Affected rows (returned when return_representation=true)

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
501
Not Implemented Error
503
Service Unavailable Error