# Truncate an Indexes table

This endpoint truncates a given Indexes table.

Method Path Operation*
DELETE /account/services/indexes/{index}/data truncate_indexes_table

*

In order for a user to perform the "truncate_indexes_table" operation, the "truncate_indexes_table" permission must be included in the list of allowed actions in the statement of the user's role.

# Request

Parameter Type In Description
index
required
string path Name of the Indexes table to be truncated.

# Response

Attribute Type Description
stats dictionary
Indexes table stats.
Attribute Type Description
table_size integer Size, in bytes, of actual data stored in the database table backing the Index.
index_size integer Size, in bytes, of indices created on the database table backing the index.
toast_size integer Size, in bytes, of the TOAST (The Oversized-Attribute Storage Technique (opens new window)) data for the database table backing the index.
total_size integer Total size, in bytes, of the database relation (sum of actual, indices and toast data) backing the index.
properties dictionary
Dictionary containing a list of property names and a list of data types of the corresponding properties.
Attribute Type Description
names list of strings Name/names of the property/properties. Each of the names must match the regular expression (opens new window) ^[a-z_][0-9a-z_]{0,63}$.
types list of string, value is "int", "bigint", "smallint", "integer", "numeric", "double precision", "json", "jsonb", "bool", "boolean", "character varying", "varchar", "text", "date", "time", "interval", "timestamp", "timestamptz", or "uuid". Data types of the corresponding properties.
rule string Rule used to select Twins which should be present in the given Indexes table.
templates dictionary Dictionary containing templates for "properties" in form of key-value pairs:
key: property name,
value: template.
The templates follow the Python string format() convention (see Format String Syntax (opens new window)).

# Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status Codes section.