logs/search

Namespace Name Admin Only Log Summary Generates Event Version Added
logs search no no no 1

Description

Search through the logs and return results

Input Arguments

  • Required Arguments: none ({})
  • Optional Arguments:
    • “time_end” (string - if not supplied it defaults to the current time)
    • “time_start” (string - if not supplied it defaults to one month prior to the end time)
    • “user_id” (string - only return log entries associated with this user)
    • “api_header” (string - only return log entries associed with a particular API call: such as “users/add” or “servers/edit”)

For information about the time formats, please look at the Input Time Codes section for details.

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.


  "user_id" : "user_uuid",
  "time_end" : "5d",
  "time_start" : "30d",
  "api_header" : "users/add"
}

Reply Example

NOTE: The actual reply structure will be much more expansive than shown here (more sub-fields and datasets within the sub-fields per field).

{
  "logs_start" : "2017-03-01T10:10:03Z",
  "logs_end" : "2017-03-31T10:10:03Z",
  "logs" : [
    {
      "logtime" : <ISO 8601 date format (yyyy-MM-ddThh:mm:ssZ)>,
      "logtime_t" : "time_t_number",
      "user_id" : "user_uuid",
      "api_header" : "users/add",
      "input_args" : { <json arguments> },
      "output_args" : { <json arguments> },
      "summary" : {<optional summary of changes> }
    } ,
    {
      "logtime" : <ISO 8601 date format (yyyy-MM-ddThh:mm:ssZ)>,
      "logtime_t" : "time_t_number",
      "user_id" : "user_uuid",
      "api_header" : "users/add",
      "input_args" : { <json arguments> },
      "output_args" : { <json arguments> },
      "summary" : {<optional summary of changes> }
    } 
  ]
}

NOTE: The “summary” object for logs is optional. It will only exist for those API calls that include it within their associated API documentation. Please reference the associated API calls for the format/existance of the summary object.

Events

This API call does not emit any middleware events.

Log Summary

This API call does not generate a detailed log summary item