NEnetxms
Logs

Get log schema

Changed on

Retrieve log definition including the list of columns with their data types. Columns marked with detail are not included in query results and are only returned when reading a single record. Zone columns are omitted when zoning is disabled.

get/v1/logs/{log-name}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/logs/{log-name}
  • Auth
    HTTP bearer

Response

Log definition retrieved successfully

namestring

Log name to be used in log API requests

descriptionstring nullable

Human readable description of log content

recordIdColumnstring nullable

Name of the column holding the record ID used by the single record endpoint

objectIdColumnstring nullable

Name of the column referencing the related NetXMS object, if any

Changes