DELETE
/
segments
/
{tableName}
Delete the list of segments provided in the queryParam else all segments
curl --request DELETE \
  --url https://dev.startree.ai/segments/{tableName} \
  --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
required

OFFLINE|REALTIME

​
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

​
segments
string[]

Segment names to be deleted if not provided deletes all segments by default

Response

200 - application/json

successful operation

The response is of type object.