Get Tables

Gets a list of the tables that match the search keyword.

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
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/tables
Request Parameters
KeyRequiredTypeDescriptionNote
offsetX32-bit integerNumber of records to skipDefault: 0
limitX32-bit integerMaximum number of records to loadDefault: 2147483647
keywordsXStringKeywordSearch available by table_name
company_guidXStringCompany GUIDOption only available for a cluster administrator

Success Response

{
  "total_count": 1,
  "tables": [
    {
      "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
      "company_name": "Logpresso",
      "table_name": "evtx_system",
      "layout": "columnar",
      "compression": "snappy",
      "retention": 180,
      "min_day": "2021-10-19 00:00:00+0900",
      "max_day": "2022-09-14 00:00:00+0900",
      "table_size": 7195337,
      "index_size": 0,
      "ratio": 100
    }
  ]
}
  • total_count (32-bit integer): Total number of tables that match the search keyword
  • tables (Array): Table list
    • 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
    • crypto_profile_guid (String): Encryption profile GUID
    • crypto_profile_name (String): Encryption profile name
    • min_day (String): Minimum log date stored (based on _time field)
    • max_day (String): Maximum log date stored (based on _time field)
    • table_size (64-bit integer): Table data size (Bytes)
    • index_size (64-bit integer): Index data size (Bytes)
    • retention (32-bit integer): Data retention period (in days)
    • ratio (64-bit real number): Storage usage ratio

Error Responses

offset or limit value is not an integer

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}
offset or limit value is negative

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}
Identifier is not in valid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "company_guid should be guid type."
}