latestOpenAPI 3.0.3Wowza Media Systems2026-08-10314187777.4 KB

f2200a734783

Servers Configuration

Get log

Retrieves the contents of a server log with the specified log name. This API is available in builds 15089 or later.

get/v2/servers/{serverName}/logfiles/{logName}

Path parameters

serverNamestring required

Reserved for future use

logNamestring required

The name of the log

Query parameters

lineCountstring

The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset

startOffsetstring

The byte offset in the file at which to begin getting log lines

filterstring

A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings

searchstring

A string containing a literal string on which to filter or a regex

regexSearch'false' | 'true'

Indicates if the 'search' parameter is a regex or a literal string

headstring

Returns the first x lines from the requested log file, the overrides the startoffset and linecount values

tailstring

Returns the last x lines from the requested log file, the overrides the startoffset and linecount values

Response

Successful response

endOffsetinteger required
logStartDatestring required
logDatestring required
endDatestring required
serverNamestring required
versionstring required
logLinesstring[] required
filterStrstring required
retLineCountinteger required
logFieldsstring required
logSoftwarestring required
startOffsetinteger required
searchStrstring required
regexSearchboolean required
logVersionstring required
saveFieldListstring[]
fileLengthinteger required
startDatestring required