Get Table

Retrieves configuration and status information of a specified table.

Tip
Even on the same instance, configuration information for tables created in Logpresso Enterprise is not retrieved because it does not exist in Logpresso Sonar.

HTTP Request

GET /api/sonar/tables/:table
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/tables/demo
Request Parameter
KeyRequiredTypeDescriptionNote
tableOStringTable nameCase-sensitive. Minimum 1 to maximum 50 characters
Note
Table names can only contain numbers, upper and lower case alphabets, and underscores.

Success Response

{
  "table": {
    "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
    "company_name": "Logpresso",
    "table_name": "evtx_system",
    "layout": "columnar",
    "compression": "snappy",
    "retention": 180,
    "table_size": 7731856,
    "index_size": 10645038,
    "ratio": 100,
    "min_day": "2021-10-19 00:00:00+0900",
    "max_day": "2022-09-14 00:00:00+0900",
    "shared_users": [
      {
        "type": "USER",
        "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
        "name": "Joshua",
        "read_only": true,
        "created": "2022-09-11 21:57:20+0900"
      }
    ],
    "shared_groups": [],
    "node_stats": [
      {
        "node_pair_name": "control",
        "table_size": 7731856,
        "index_size": 10645038,
        "min_day": "2021-10-19 00:00:00+0900",
        "max_day": "2022-09-14 00:00:00+0900"
      }
    ]
  }
}
  • table (Map): Tabele configurations
    • company_guid (String): Company (tenant) GUID
    • company_name (String): Company (tenant) name
    • table_name (String): Table name
    • layout (String): Block layout
    • compression (String): Compression algorithm
    • retention (32-bit integer): Data retention period (days)
    • crypto_profile_guid (String): Encryption profile GUID
    • crypto_profile_name (String): Encryption profile name
    • table_size (64-bit integer): Table data size (Bytes)
    • index_size (64-bit integer): Index data size (Bytes)
    • ratio (64-bit real number): Ratio of disk usage for the table to the disk usage of all tables.
    • min_day (String): Minimum log date stored (based on _time field)
    • max_day (String): Maximum log date stored (based on _time field)
    • shared_users (Array): List of the users with privilege for the table
      • type (String): Always USER
      • guid (String):
    • shared_groups (Array): List of the user groups with privilege for the table
    • node_stats (Array): Table statistics information by nodes
      • node_pair_name (String): Node pair name
      • table_size (64-bit integer): Table data size
      • index_size (64-bit integer): Index data size
      • min_day (String): Minimum log date stored (based on _time field)
      • max_day (String): Maximum log date stored (based on _time field)

Error Response

Table is not found

HTTP status code 200

{
  "table": null
}