Apps or clients can make HTTP requests to Papertrail to programmatically search for events. Papertrail’s own papertrail-cli uses the API.
The log search API endpoint is one part of Papertrail’s HTTP API. All API calls use the same authentication and request/response format. To manage account resources, such as to create groups or register new senders, see Settings API.
The search API endpoint is https://papertrailapp.com/api/v1/events/search.json.
All parameters are optional.
q: search query; return events matching this query (default: return all events)
system_id: limit results to a specific system (accepts ID or name)
group_id: limit results to a specific group (accepts ID only)
min_time: the oldest message ID or timestamp to examine
max_time: the newest message ID or timestamp to examine
limit: maximum messages to return (default 1000, maximum 10,000)
tail: search approach to use
max_time should be in epoch time UTC.
tail parameter is intended for use when implementing live tail search. It defaults to true when
min_id is provided and neither
max_time is provided, because that format is typical when the intent is to retrieve recent logs. It changes the search approach to prioritize event recency over completeness; otherwise, a live tail implementation might get behind if the rate of new messages was high.
tail is set to
true with other parameter combinations, it has minimal effect, and this usage isn’t recommended. To retrieve recent events but prioritize completeness instead, specify
Request the 1000 most recent events:
$ curl -v -H "X-Papertrail-Token: abc123" https://papertrailapp.com/api/v1/events/search.json
Search for events containing
$ curl -v -H "X-Papertrail-Token: abc123" https://papertrailapp.com/api/v1/events/search.json?q=error
All search queries that work in the Papertrail Web interface also work in the API.
Parameters should be URL-encoded, as is standard for GET query strings. For example, the search string:
ssh OR ("authentication failure" AND success)
would create this request:
$ curl -v -H "X-Papertrail-Token: abc123" https://papertrailapp.com/api/v1/events/search.json?q=ssh%20OR%20%28%22authentication%20failure%22%20AND%20success%29
Searching for the simpler phrase
$ curl -v -H "X-Papertrail-Token: abc123" https://papertrailapp.com/api/v1/events/search.json?q=%27Critical%20error%27
To limit results to a specific group or system, include
group_id in the query string. For example:
$ curl -v -H "X-Papertrail-Token: abc123" 'https://papertrailapp.com/api/v1/events/search.json?q=unable&system_id=1234'
searches system ID 1234 for
$ curl -v -H "X-Papertrail-Token: abc123" 'https://papertrailapp.com/api/v1/events/search.json?q=SELECT&group_id=2345'
searches group ID 2345 for
Unique system names (
name in the system JSON hash; see Systems LIST) that contain only numbers, letters, and underscores can be used for
system_id as well. This can simplify linking to results for a single system, since no name-to-mapping API query is necessary. For example:
$ curl -v -H "X-Papertrail-Token: abc123" 'https://papertrailapp.com/api/v1/events/search.json?system_id=www42&q=user'
would search system
To search only a particular time range, provide a minimum and/or maximum event ID or time. For example, to retrieve events from Monday, June 19 2017 at 9:35 am Pacific to Monday, June 19 2017 at 9:40am Pacific, the Pacific times are first converted to epoch time format, then added as query parameters:
$ curl -v -H "X-Papertrail-Token: abc123" 'https://papertrailapp.com/api/v1/events/search.json?min_time=1497890100&max_time=1497890400'
The search endpoint returns a JSON object containing these keys:
events: an array of hashes of log events (one hash per event)
min_id: the lowest event ID examined
max_id: the highest event ID examined
In addition to
max_id, the response object may also contain
max_time_at. These are the oldest or newest timestamps searched during this request. These keys are useful for displaying the time the search spanned in a human-friendly way, but since multiple events may have occured during the same second, they should not be used to select a time range for subsequent queries.
Within each log event hash, the following keys are included:
id: unique Papertrail event ID (64-bit integer as JSON string)
generated_at: time that the log event was generated (ISO 8601 timestamp)
received_at: time that Papertrail received the log event (ISO 8601 timestamp)
display_received_at: time that Papertrail received the log event (formatted date-time string)
source_name: sender name in Papertrail (string)
hostname: hostname of the message (string)
source_id: unique Papertrail sender ID (32-bit integer)
source_ip: IP address that originated this log event (string)
facility: syslog facility (string)
severity: syslog severity (string)
program: syslog “tag” field, more commonly called program (string)
message: log event message (string)
eventswill be an empty array (
) if no events were found matching the query.
display_received_atare in the time zone of the API token owner (set in the profile).
idvalues for a series of events indicate relative event order and will only increase, but
idvalues are not sequential.
programmay be null if not defined by the event.
messageis a blank string (
Each search query will return one of three types of result sets. The client can use the type to decide what to do next. The 3 possible types are:
true. All matching events from the set
max_timeback to the beginning of searchable retention were examined.
true. All matching events from the set
min_timeup to the present were examined.
limit-size set of matching log messages (default 1000). The
eventsarray contains these elements, and
reached_record_limitis included in the result.
true. Papertrail’s per-request time limit was reached before a full set of events was found.
Per-request time limit
Papertrail’s workload varies significantly based on the number of possible events and the complexity of the query. To ensure that the caller does not block forever, the search API automatically enforces a per-request time limit of about 5 seconds. When the response contains
reached_time_limit, this time limit expired before the full set of results was returned.
Events, reached beginning
"message": "message body",
"display_received_at": "May 18 20:30:02",
"message": "A short event",
"display_received_at": "May 18 20:30:02",
No events (reached beginning)
Events, reached time limit
"events":["...some number of events here..."],
Events, reached record limit
"events":["...1000 events here..."],
Clients may implement a “live tail” (
tail -f-style) display by performing multiple successive searches for the same search query (or no search query).
min_id(oldest message returned) and
max_id(newest message returned).
max_id(newest message seen) and pass it back as
min_id. Passing in a
min_idsays “Give me messages newer than this ID”, so the result includes messages not previously seen.
tail=falseor use one of the options below.
To get older events (rather than current events), pass a
max_time to Papertrail and it will return the most recent events that are older than that ID or time.
To scroll back through progressively older events (similar to the behavior of the Papertrail viewer filling in older events over time once it finds recent results), pass the
min_id from the Papertrail response back in as the
max_id for the next request.
For the first request, supply the two endpoint times, in epoch time, as
Papertrail may search the entire timespan in the initial request and return all of the results.
If there are too many results for a single response, or the per-request time expired before the search was complete, subsequent resquests should move backward through older events until the earliest desired time is reached. There are a number of ways to implement this; here are two relatively simple ones:
min_id(oldest event returned) and pass it back as
max_id, while maintaining the same
min_timeparameter. Because of the presence of the
min_timeparameter, the subsequent response will include the previous oldest event reached as the latest event; simply discard it, as it was previously retrieved.
min_timeparameter in subsequent requests, preventing event overlap. For each subsequent response, compare the
min_time_atparameter to the desired start time, and stop when that time is reached, discarding any events with earlier times.
A reference implementation is also available in the Papertrail CLI.
If you have any questions about how to handle incomplete result sets or implement a particular style of search, contact us.The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.