Welcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on the collector and search APIs see our API home page.

Sumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment see API endpoints.

Sumo Logic supports the following options for API authentication:

• Access ID and Access Key
• Base64 encoded Access ID and Access Key

See Access Keys to generate an Access Key. Make sure to copy the key you create, because it is displayed only once. When you have an Access ID and Access Key you can execute requests such as the following:

curl -u "<accessId>:<accessKey>" -X GET https://api.<deployment>.sumologic.com/api/v1/users

Where deployment is either au, ca, de, eu, fed, in, jp, us1, or us2. See API endpoints for details.

If you prefer to use basic access authentication, you can do a Base64 encoding of your <accessId>:<accessKey> to authenticate your HTTPS request. The following is an example request, replace the placeholder <encoded> with your encoded Access ID and Access Key string:

curl -H "Authorization: Basic <encoded>" -X GET https://api.<deployment>.sumologic.com/api/v1/users

Refer to API Authentication for a Base64 example.

Generic status codes that apply to all our APIs. See the HTTP status code registry for reference.

Some API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand & character.

For example, to get 20 users whose firstName is John and lastName is Doe:

api.sumologic.com/v1/users?limit=20&firstName=John&lastName=Doe

Some API endpoints support sorting fields by using the sortBy query parameter. The default sort order is ascending. Prefix the field with a minus sign - to sort in descending order.

For example, to get 20 users sorted by their email in descending order:

api.sumologic.com/v1/users?limit=20&sort=-email

Asynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.

1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies your asynchronous job.

2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous request will typically provide an endpoint to poll for the status of asynchronous job. A successful response from the status endpoint will have the following structure:

   {
    "status": "Status of asynchronous request",
    "statusMessage": "Optional message with additional information in case request succeeds",
    "error": "Error object in case request fails"
   }
   

   The status field can have one of the following values:

   1. Success: The job succeeded. The statusMessage field might have additional information.
   2. InProgress: The job is still running.
   3. Failed: The job failed. The error field in the response will have more information about the failure.

3. Some asynchronous APIs may provide a third endpoint (like export result) to fetch the result of an asynchronous job.

Example

Let's say we want to export a folder with the identifier 0000000006A2E86F. We will use the async export API to export all the content under the folder with id=0000000006A2E86F.

1. Start an export job for the folder

   curl -X POST -u "<accessId>:<accessKey>" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export
   

   See authentication section for more details about accessId, accessKey, and deployment. On success, you will get back a job identifier. In the response below, C03E086C137F38B4 is the job identifier.

   {
    "id": "C03E086C137F38B4"
   }
   

2. Now poll for the status of the asynchronous job with the status endpoint.

   curl -X GET -u "<accessId>:<accessKey>" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status
   

   You may get a response like

   {
    "status": "InProgress",
    "statusMessage": null,
    "error": null
   }
   

   It implies the job is still in progress. Keep polling till the status is either Success or Failed.

3. When the asynchronous job completes (status != "InProgress"), you can fetch the results with the export result endpoint.

   curl -X GET -u "<accessId>:<accessKey>" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result
   

The asynchronous job may fail (status == "Failed"). You can look at the error field for more details.

{
    "status": "Failed",
    "errors": {
        "code": "content1:too_many_items",
        "message": "Too many objects: object count(1100) was greater than limit 1000"
    }
}

• A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.
• A rate limit of 10 concurrent requests to any API endpoint applies to an access key.

If a rate is exceeded, a rate limit exceeded 429 status code is returned.

You can use OpenAPI Generator to generate clients from the YAML file to access the API.

Using NPM

1. Install NPM package wrapper globally, exposing the CLI on the command line:

   npm install @openapitools/openapi-generator-cli -g
   

   You can see detailed instructions here.

2. Download the YAML file and save it locally. Let's say the file is saved as sumologic-api.yaml.

3. Use the following command to generate python client inside the sumo/client/python directory:

   openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python
   

Using Homebrew

1. Install OpenAPI Generator

   brew install openapi-generator
   

2. Download the YAML file and save it locally. Let's say the file is saved as sumologic-api.yaml.

3. Use the following command to generate python client side code inside the sumo/client/python directory:

   openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python
   

Archive Ingestion Management API.

Archive Ingestion allows you to ingest data from Archive destinations. You can use this API to ingest data from your Archive with an existing AWS S3 Archive Source. You need the Manage or View Collectors role capability to manage or view ingestion jobs. For more information see Archive.

Health Events management API.

Health Events allow you to keep track of the health of your Collectors and Sources. You can use them to find and investigate common errors and warnings that are known to cause collection issues. For more information see Health Events.

Log Search Estimated Usage API.

Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier, over a particular time range. In the Infrequent Data Tier, you pay per query, based on the amount data scanned. You can use this endpoint to get an estimate of the total data that would be scanned before running a query, and refine your query to scan less data, as necessary. For more information see Infrequent data tier.

Ingest Budget management API.

Ingest Budgets allow you to control the capacity of daily ingestion volume sent to Sumo Logic from Collectors. For more information see Ingest Budgets.

Ingest Budget management API V2.

Ingest Budgets V2 provide you the ability to create and assign budgets to your log data by Fields instead of using a Field Value. For more information see Metadata Ingest Budgets.

App installation API.

View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction for popular data sources. For more information see Sumo Logic Apps.