Before You Start

Documentation version: 2604.0

Product version: 5.0.2603.0

This guide is written for Sonar 5.0.2603.0. For version-by-version changes, see Documentation history.

Notice

This document is the reference for the REST API provided by Logpresso Sonar. Before calling any API, read Your first call to learn the base URL, how to issue an API key, the authentication header, and the standard request and response formats.

Logpresso strives to keep the documentation accurate and up to date, but examples may not always match the product exactly. The documentation is provided as is. If you find an error, contact Logpresso.

Notation

HTTP requests are written as follows.

Notation	Meaning
`GET /api/sonar/loggers`	The HTTP method and request path are written in monospace.
`:guid`, `<API_KEY>`, `HOSTNAME`	Placeholders the caller fills in based on their environment.
`O` / `X` in the Required column	In request parameter tables, `O` means required and `X` means optional.

Data types in request parameters and response bodies are written using their canonical names (String, 32-bit integer, 64-bit integer, Boolean, Timestamp, IP address, and so on).