DELETE
/
segments
/
{tableName}
/
choose
curl --request DELETE \
  --url https://dev.startree.ai/segments/{tableName}/choose \
  --header 'Authorization: <api-key>'
{
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

The format of the key is "Basic <token>" or "Bearer <token>"

Path Parameters

​
tableName
string
required

Name of the table

Query Parameters

​
type
string

OFFLINE|REALTIME

​
excludeReplacedSegments
boolean
default:false

Whether to ignore replaced segments for deletion, which have been replaced specified in the segment lineage entries and cannot be queried from the table, false by default

​
startTimestamp
string
required

Start timestamp (inclusive) in milliseconds

​
endTimestamp
string
required

End timestamp (exclusive) in milliseconds

​
excludeOverlapping
boolean
default:true

Whether to ignore segments that are partially overlapping with the [start, end)for deletion, true by default

​
retention
string

Retention period for the table segments (e.g. 12h, 3d); If not set, the retention period will default to the first config that's not null: the table config, then to cluster setting, then '7d'. Using 0d or -1d will instantly delete segments without retention

Response

200 - application/json
successful operation

The response is of type object.