Log Monitoring API v1 - Hosts
deprecated
This API is deprecated.
- For Log monitoring - Custom devices, Hosts, or Process Groups, what to use instead depends on which version of Log Monitoring you use:
- Log Management and Analytics: Grail Query API
- Log Monitoring Classic: Log Monitoring API
- For Calculated metrics - Log Monitoring, use the Settings API endpoint with schemaId
builtin:logmonitoring.schemaless-log-metric.
The Log Monitoring—Hosts API enables you to automate your log monitoring tasks for the operational systems logs.
The following example is a typical sequence of API calls for log analysis.
-
Fetch the list of logs. Make an API call to find out what logs are available for processing.
As a response you will receive the list of available logs.
-
From the response of the previous call, you know which logs are available. You can start a log analysis job for one of them.
As a response, you will receive the ID of the job.
-
Now that you have the ID of the analysis job, you can check the status of the job.
As a response, you will receive the information about the job: the status of the job, timestamp of last status change, any errors that occurred, and a number of processed log entries.
-
When the status of the log analysis job is
READY, you can view the content of the log. You have the following options:As a response, you will receive the records of the log.
-
If you have completed your analysis, delete the analysis job. You can also cancel the unfinished job with this call.