Search API

Search API

This document describes the API exposed by the Sumo Logic service. It can be used to access resources and log data within the service by third party scripts and applications. The API follows REST (representational state transfer) patterns and is optimized for ease of use and consistency.

Calling the API

Authentication

Any request made to the Sumo Logic API needs to include an HTTP Basic Authentication header (see RFC 2617) generated from a users email and password. All modern browsers, as well as command line tools like curl and wget support basic authentication. This is secure, since all communication with the Sumo Logic service happens over SSL/HTTPS.

Endpoints and versioning

The base URL for all Sumo Logic API calls is https://api.sumologic.com/api/[version]/, where [version] is the version of the API. The API documented here is version v1, consequently, the base URL is:

https://api.sumologic.com/api/v1/

Data formats

Resources are accepted and returned in JSON (JavaScript Object Notation) format by default. Support for other formats may be added in future versions.

Errors

Upon error, the API responds with an HTTP response and a JSON document with further details on the error. Here are some common HTTP responses:

Code	Description
400 Bad Request	The request was malformed.
401 Unauthorized	The authentication did not succeed.
403 Forbidden	No permission to access the requested resource.
404 Not Found	A requested resource could not be found.
500 Server Error	There was an error executing the request.
503 Service Unavailable	The service is currently unavailable/in maintenance.