Skip to main content
POST
Query bounded retained JSON, text lines or binary byte ranges

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
handle
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
mode
enum<string>
default:json
Available options:
json,
text,
bytes
expression
string
default:@
Required string length: 1 - 256
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991
limit
integer
default:25
Required range: 1 <= x <= 1000
maxResultBytes
integer
default:4096
Required range: 2048 <= x <= 32768

Response

Bounded selected data

handle
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
mode
enum<string>
required
Available options:
json,
text,
bytes
data
any
required
offset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
nextOffset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
done
boolean
required
encoding
enum<string>
required
Available options:
json,
utf8,
base64