# Get Indexes tables

This endpoint retrieves:

  • a lists of existing Indexes tables,
  • the "stats" attribute that holds the "status" and the "database_size" attributes,
  • a list of users with access to the Indexes database with their access permissions.
Method Path Operation*
GET /account/services/indexes get_indexes_tables


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

# Request

No parameters.

# Response

The response returns the "stats" attribute. It holds the "status" and the "database_size" attributes, a list of users with their respective access permissions to the Indexes database held in the "users" attribute, and the names of the Indexes tables held in the "indexes" attribute.

Attribute Type Description
stats dictionary
Indexes database stats.
Attribute Type Description
status string, value is "running", "pending", or "service" Status of the database:
- "running": The Indexes database is running.
- "pending": The Indexes database is in the process of initialising.
- "service": Unexpected behaviour occurred and the Indexes database is not available.
database_size integer Size, in bytes, of the Timeseries and Indexes database.
database_uuid string UUID of the database.
users dictionary Key-value pairs:
- key: User UUID.
- value: Must be "read" (the user is only allowed to read the Indexes database, not to make any changes) or "write" (the user is allowed to read the Indexes database and to make changes to it. Users with no access to the Indexes database will not be returned in the response.
indexes list of strings List of names of Indexes tables in the Indexes database.

# Status codes

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

Was this article helpful?