Sumo Logic, profile picture
Uploaded bySumo Logic
PDF, PPTX1,125 views

How To Webinar - Sumo Logic API

This document provides an overview of the Sumo Logic API, including authentication methods, rate limits, and API endpoints for searching logs and managing search jobs. It details the structure of requests and responses, the handling of errors, and best practices for using the API effectively. Additionally, it includes links to client libraries, documentation, and support resources.

Embed presentation

Download as PDF, PPTX
Sumo Logic Confidential Sumo Logic API Welcome. You are currently in listen-only mode. To give everyone a chance to successfully connect, we’ll start at 10:05 AM Pacific. How-To Webinar Frank Reno, Customer Success March 2016
Sumo Logic Confidential Available APIs Performing Searches Managing Collectors Interacting with Dashboards (Beta)
Sumo Logic Confidential General API Details • Authentication – Initial request MUST include a HTTP Basic Authentication header using a username/password or access id/access key – API Authentications are limited to 15 calls per minute – Multiple requests should use cookies • The initial request will return a cookie containing two attributes: JSESSIONID and AWSELB. These can be included in subsequent requests to reduce the number of authentication calls.
Sumo Logic Confidential • API requests are limited to 4 calls per second • Data Formats – All data is sent and received in JSON • API URL – Depends on your service region: General API Details Service URL API URL https://service.sumologic.com https://api.sumologic.com/api/v1/ https://service.us2.sumologic.com https://api.us2.sumologic.com/api/v1/ https://service.us4.sumologic.com https://api.us4.sumologic.com/api/v1/ https://service.eu.sumologic.com https://api.eu.sumologic.com/api/v1/ https://service.au.sumologic.com https://api.au.sumologic.com/api/v1/
Sumo Logic Confidential • Errors – Errors are returned with an HTTP status code and JSON document. – General Error Codes • auth.failed – The authentication has failed • internal.error – Internal server error • unauthorized – Incorrect username/password • service.unavailable – The service is unavailable General API Details
Sumo Logic Confidential • Ideal for fast, non-trivial queries • Synchronous • Limitations – Search must complete within 1 minute or it will timeout – A max of about 100K results will be returned. If you need more results, you will need to execute subsequent requests with smaller time rages or use the Search Job API. Search API
Sumo Logic Confidential • Endpoint: /logs/search • Method: GET *Time range values can be specified in ISO 8601 format or epoch milliseconds. • https://api.sumologic.com/api/v1/logs/search?q=error&from=2012-04- 04T13:01:02&to=2012-04-04T15:01:02 Search API Parameter Required Default Description q Yes N/A The full search query to be executed. from No -15m Start of the time range. to No Now End of the time range. tz No Etc/UTC Time Zone format in TX format format No json The desired result format. Supported: json and text.
Sumo Logic Confidential • Sample JSON Response Document Search API
Sumo Logic Confidential Note: • This API may be deprecated in the future, in favor of the Search Job API. • Use the Search Job API where you can. Search API
Sumo Logic Confidential • Models the asynchronous behavior of a search in the Sumo Logic backend – Creating a search job returns immediately with the ID for the search job. The ID can then be used to interact with the search job. • Provides histogram bucket information • Asynchronous • Limitations – The Search Job API does not have the limitations that the Search API has. Search Job API
Sumo Logic Confidential • Endpoint: /search/jobs • Method: POST • Headers – Content-Type - application/json – Accept - application/json *Time rangevaluescan bespecifiedin ISO8601 formator epoch milliseconds. Search Job API - Creating a Search Job Parameter Type Required Description query String Yes The full search query to be executed. from String Yes Start of the time range to String Yes End of the time range timezone String Yes Time Zone format in TX format
Sumo Logic Confidential • Status Codes • Response Headers • Sample JSON Response Document Search Job API - Creating a Search Job Status Code Text Description 202 Accepted The search job has been successfully created. 415 Unsupported Media Type Content-Type wasn't set to application/json. 400 Bad Request Generic request error by the client. Header Value Location https://api.sumologic.com/api/v1/search/jobs/SEARCH_JOB_ID
Sumo Logic Confidential • Common Error Reasons – Query is not specified – Query is invalid – From/to parameters are not specified – To is before from time – From/to values invalid format – Time zone parameter missing • If any of the above occur, the response body will contain additional information. • Don’t forget to properly escape your query Search Job API - Creating a Search Job
Sumo Logic Confidential • Endpoint: /search/jobs/SEARCH_JOB_ID • Method: GET Search Job API - Checking the status of a Search Job Sumo Logic Confidential14 Parameter Type Required Description SEARCH_JOB_ID String Yes The ID of the search job.
Sumo Logic Confidential • Sample JSON Response Document • Possible States Search Job API - Checking the status of a Search Job State Description NOT STARTED Search job has not been started yet. GATHERING RESULTS Search job is still gathering more results, however results might already be available. DONE GATHERING RESULTS Search job is done gathering results; the entire specified time range has been covered. CANCELLED The search job has been cancelled.
Sumo Logic Confidential • messageCount – The count of raw log messages • recordCount – The count of aggregates • If your search does not contain any aggregation operators, only the messageCount is returned. • pendingErrors, pendingWarnings and histogramBuckets ARE NOT cumulative – Each request will return the information found since the last request. The client will need to store these if they must be remembered. Search Job API - Checking the status of a Search Job
Sumo Logic Confidential • Endpoint: /search/jobs/SEARCH_JOB_ID/messages?offset=OFFSET&limit=LIMIT • Method: GET *The maximumvalue forlimit is 10,000 messages Search Job API - Paging thru messages Parameter Required Description SEARCH_JOB_ID Yes The ID of the search job. OFFSET Yes Return messages starting at this offset. LIMIT Yes The number of messages starting at offsetto return.
Sumo Logic Confidential • Sample JSON Response Document • The result will contain two lists – Fieldsis all the fieldsdefined for themessages – Messagescontainsa list of maps, onemap for each message Search Job API - Paging thru messages
Sumo Logic Confidential • Endpoint: /search/jobs/SEARCH_JOB_ID/records?offset=OFFSET&limit=LIMIT • Method: GET *The maximumvalue forlimit is 10,000 messages Search Job API - Paging thru records Parameter Required Description SEARCH_JOB_ID Yes The ID of the search job. OFFSET Yes Return records starting at this offset. LIMIT Yes The number of records starting at offset to return.
Sumo Logic Confidential • Sample JSON Response Document • The result will contain two lists – Fieldsis all the fieldsdefined for therecords – Recordscontainsa list of maps, onemap for each records Search Job API - Paging thru records
Sumo Logic Confidential • Endpoint:/search/jobs/SEARCH_JOB_ID • Method: DELETE • Although search jobs ultimately timeout, it is best practice to delete a search job when it is no longer needed. Search Job API - Deleting a Search Job
Sumo Logic Confidential Search Job API Demo
Sumo Logic Confidential • Java Client Library – Available on Maven Central – https://github.com/SumoLogic/sumo-java-client • Python Client Library – https://github.com/SumoLogic/sumologic-python-sdk Search Libraries
Sumo Logic Confidential • Documentation – https://github.com/SumoLogic/sumo-api-doc/wiki – https://support.sumologic.com/hc/en-us/sections/200934938-APIs • Community Forum – https://support.sumologic.com/hc/communities/public/topics/200263058- Sumo-Logic-API • Email – api@sumologic.com API Resources

More Related Content

PPTX
"How to" Webinar: Sending Data to Sumo Logic
bySumo Logic
 
PPTX
Sumo Logic QuickStart
bySumo Logic
 
PDF
Sumo Logic Quickstart Training 10/14/2015
bySumo Logic
 
PDF
Sumo Logic QuickStart Webinar
bySumo Logic
 
PPTX
Sumo Logic "How to" Webinar: Advanced Analytics
bySumo Logic
 
PDF
Sumo Logic - Optimizing Your Search Experience (2016-08-17)
bySumo Logic
 
PDF
Level 3 Certification: Setting up Sumo Logic - Oct 2018
bySumo Logic
 
PDF
Optimizing Your Search Experience
bySumo Logic
 
"How to" Webinar: Sending Data to Sumo Logic
bySumo Logic
 
Sumo Logic QuickStart
bySumo Logic
 
Sumo Logic Quickstart Training 10/14/2015
bySumo Logic
 
Sumo Logic QuickStart Webinar
bySumo Logic
 
Sumo Logic "How to" Webinar: Advanced Analytics
bySumo Logic
 
Sumo Logic - Optimizing Your Search Experience (2016-08-17)
bySumo Logic
 
Level 3 Certification: Setting up Sumo Logic - Oct 2018
bySumo Logic
 
Optimizing Your Search Experience
bySumo Logic
 

What's hot

PPTX
Welcome Webinar Slides
bySumo Logic
 
PPT
Boosting Documents in Solr by Recency, Popularity and Personal Preferences - ...
bylucenerevolution
 
PPTX
Sumo Logic Cert Jam - Metrics Mastery
bySumo Logic
 
PPTX
Sumo Logic Cert Jam - Metrics Mastery
bySumo Logic
 
PPTX
Sumo Logic QuickStart Webinar - Get Certified
bySumo Logic
 
PPTX
Using Sumo Logic - Apr 2018
bySumo Logic
 
PPTX
Sumo Logic Cert Jam - Fundamentals
bySumo Logic
 
PPT
Boosting Documents in Solr by Recency, Popularity, and User Preferences
byLucidworks (Archived)
 
PDF
Level 2 Certification: Using Sumo Logic - Oct 2018
bySumo Logic
 
PDF
Security Certification: Security Analytics using Sumo Logic - Oct 2018
bySumo Logic
 
PDF
Apache Solr/Lucene Internals by Anatoliy Sokolenko
byProvectus
 
PDF
Relevance in the Wild - Daniel Gomez Vilanueva, Findwise
byLucidworks
 
PPTX
Sumo Logic QuickStart Webinar July 2016
bySumo Logic
 
PDF
Sumo Logic Quick Start - Feb 2016
bySumo Logic
 
PPTX
Sumo Logic QuickStart - May 2016
bySumo Logic
 
PPTX
Sumo Logic "How To" Webinar: Apps
bySumo Logic
 
PPT
Advanced full text searching techniques using Lucene
byAsad Abbas
 
PPTX
How to Webinar: Sumo Logic Dashboards
bySumo Logic
 
PPTX
Develop IoT project with AirVantage M2M Cloud
byCrystal Lam
 
PPTX
Sumo Logic Cert Jam - Advanced Metrics with Kubernetes
bySumo Logic
 
Welcome Webinar Slides
bySumo Logic
 
Boosting Documents in Solr by Recency, Popularity and Personal Preferences - ...
bylucenerevolution
 
Sumo Logic Cert Jam - Metrics Mastery
bySumo Logic
 
Sumo Logic Cert Jam - Metrics Mastery
bySumo Logic
 
Sumo Logic QuickStart Webinar - Get Certified
bySumo Logic
 
Using Sumo Logic - Apr 2018
bySumo Logic
 
Sumo Logic Cert Jam - Fundamentals
bySumo Logic
 
Boosting Documents in Solr by Recency, Popularity, and User Preferences
byLucidworks (Archived)
 
Level 2 Certification: Using Sumo Logic - Oct 2018
bySumo Logic
 
Security Certification: Security Analytics using Sumo Logic - Oct 2018
bySumo Logic
 
Apache Solr/Lucene Internals by Anatoliy Sokolenko
byProvectus
 
Relevance in the Wild - Daniel Gomez Vilanueva, Findwise
byLucidworks
 
Sumo Logic QuickStart Webinar July 2016
bySumo Logic
 
Sumo Logic Quick Start - Feb 2016
bySumo Logic
 
Sumo Logic QuickStart - May 2016
bySumo Logic
 
Sumo Logic "How To" Webinar: Apps
bySumo Logic
 
Advanced full text searching techniques using Lucene
byAsad Abbas
 
How to Webinar: Sumo Logic Dashboards
bySumo Logic
 
Develop IoT project with AirVantage M2M Cloud
byCrystal Lam
 
Sumo Logic Cert Jam - Advanced Metrics with Kubernetes
bySumo Logic
 

Viewers also liked

PPTX
Sumo Logic Search Job API
bySumo Logic
 
PPTX
Bring your Graphite-compatible metrics into Sumo Logic
bySumo Logic
 
PPTX
How Netskope Mastered DevOps with Sumo Logic
bySumo Logic
 
PPTX
How to Reduce your MTTI/MTTR with a Single Click
bySumo Logic
 
PPTX
Simulation of urban mobility (sumo) prest
byJaskaranpreet Singh
 
PPTX
Sumo Logic Quickstart - Jan 2017
bySumo Logic
 
PPTX
Introduction to LogCompare - Reducing MTTI/MTTR with Ease
bySumo Logic
 
PDF
Simulation of Urban Mobility (Sumo) For Evaluating Qos Parameters For Vehicul...
byiosrjce
 
Sumo Logic Search Job API
bySumo Logic
 
Bring your Graphite-compatible metrics into Sumo Logic
bySumo Logic
 
How Netskope Mastered DevOps with Sumo Logic
bySumo Logic
 
How to Reduce your MTTI/MTTR with a Single Click
bySumo Logic
 
Simulation of urban mobility (sumo) prest
byJaskaranpreet Singh
 
Sumo Logic Quickstart - Jan 2017
bySumo Logic
 
Introduction to LogCompare - Reducing MTTI/MTTR with Ease
bySumo Logic
 
Simulation of Urban Mobility (Sumo) For Evaluating Qos Parameters For Vehicul...
byiosrjce
 

Similar to How To Webinar - Sumo Logic API

PPTX
Sumo Logic Cert Jam - Security & Compliance
bySumo Logic
 
PDF
Sumo Logic Certification - Level 2 (Using Sumo)
bySumo Logic
 
PPTX
Sumo Logic: Optimizing Scheduled Searches
bySumo Logic
 
PPTX
Sumo Logic Cert Jam - Search Mastery
bySumo Logic
 
PPTX
Sumo Logic Cert Jam - Administration
bySumo Logic
 
PPTX
Sumo Logic QuickStart Webinar - Dec 2016
bySumo Logic
 
PPTX
Sumo Logic Quickstart - Nv 2016
bySumo Logic
 
PPTX
Sumo Logic quickStart Webinar June 2016
bySumo Logic
 
PPTX
Sumo Logic QuickStat - Apr 2017
bySumo Logic
 
PPTX
Sumo Logic QuickStart Webinar Sep 2016
bySumo Logic
 
PPTX
Sumo Logic QuickStart Webinar Oct 2016
bySumo Logic
 
PDF
Sumo Logic QuickStart Webinar - Jan 2016
bySumo Logic
 
PDF
Tech Chat – What's New in Sumo Logic
bySumo Logic
 
PPTX
Setting Up Sumo Logic - Apr 2017
bySumo Logic
 
PDF
How to Webinar: Monitoring through Alerts
bySumo Logic
 
PPTX
Setting Up Sumo Logic - Sep 2017
bymariosany
 
PPTX
Setting up Sumo Logic - June 2017
bySumo Logic
 
PPTX
Machine Analytics: Correlate Your Logs and Metrics
bySumo Logic
 
PDF
Welcome Webinar PDF
bySumo Logic
 
PDF
Meeting the Challenge of Big Data Log Management
bySumo Logic
 
Sumo Logic Cert Jam - Security & Compliance
bySumo Logic
 
Sumo Logic Certification - Level 2 (Using Sumo)
bySumo Logic
 
Sumo Logic: Optimizing Scheduled Searches
bySumo Logic
 
Sumo Logic Cert Jam - Search Mastery
bySumo Logic
 
Sumo Logic Cert Jam - Administration
bySumo Logic
 
Sumo Logic QuickStart Webinar - Dec 2016
bySumo Logic
 
Sumo Logic Quickstart - Nv 2016
bySumo Logic
 
Sumo Logic quickStart Webinar June 2016
bySumo Logic
 
Sumo Logic QuickStat - Apr 2017
bySumo Logic
 
Sumo Logic QuickStart Webinar Sep 2016
bySumo Logic
 
Sumo Logic QuickStart Webinar Oct 2016
bySumo Logic
 
Sumo Logic QuickStart Webinar - Jan 2016
bySumo Logic
 
Tech Chat – What's New in Sumo Logic
bySumo Logic
 
Setting Up Sumo Logic - Apr 2017
bySumo Logic
 
How to Webinar: Monitoring through Alerts
bySumo Logic
 
Setting Up Sumo Logic - Sep 2017
bymariosany
 
Setting up Sumo Logic - June 2017
bySumo Logic
 
Machine Analytics: Correlate Your Logs and Metrics
bySumo Logic
 
Welcome Webinar PDF
bySumo Logic
 
Meeting the Challenge of Big Data Log Management
bySumo Logic
 

More from Sumo Logic

PPTX
Sumo Logic Cert Jam - Advanced Metrics with Kubernetes
bySumo Logic
 
PPTX
Sumo Logic Cert Jam - Fundamentals (Spanish)
bySumo Logic
 
PPTX
Sumo Logic Cert Jam - Security Analytics
bySumo Logic
 
PPTX
Scaling Your Tools for Your Modern Application
bySumo Logic
 
PPTX
Making the Shift from DevOps to Practical DevSecOps | Sumo Logic Webinar
bySumo Logic
 
PPTX
You Build It, You Secure It: Introduction to DevSecOps
bySumo Logic
 
Sumo Logic Cert Jam - Advanced Metrics with Kubernetes
bySumo Logic
 
Sumo Logic Cert Jam - Fundamentals (Spanish)
bySumo Logic
 
Sumo Logic Cert Jam - Security Analytics
bySumo Logic
 
Scaling Your Tools for Your Modern Application
bySumo Logic
 
Making the Shift from DevOps to Practical DevSecOps | Sumo Logic Webinar
bySumo Logic
 
You Build It, You Secure It: Introduction to DevSecOps
bySumo Logic
 

Recently uploaded

PPTX
apidays Australia 2025 | Hey man, which one will deploy much faster, API or kid?
byapidays
 
PDF
apidays Australia 2025 | APIs in Government: A blueprint to automating Busine...
byapidays
 
PDF
apidays Australia 2025 | The API Platform as an Agentic Buffet: Serving APIs,...
byapidays
 
PDF
apidays Australia 2025 | Designing with workflows: Using Arazzo and OpenAPI f...
byapidays
 
PDF
Gojek Clone Business Strategy: From Launch to Scale
byV3CUBE TECHNOLABS
 
PDF
How to find your event photos instantly with a selfie using SnapSeek
bySnapSeek.app
 
PDF
A Complete Guide to Progressive Web App and Their Development
byMaxtra Technologies
 
PPTX
Windows File System Monitoring Tool Using C and C++
byAkshay Muley
 
PDF
Own Your Domain Before It Owns You - Domain Driven Design for Pragmaticians
byPosedio GmbH
 
PDF
🤖🧰 SPRING AI AGENTIC PATTERNS (PART 1): AGENT SKILLS
byVincent Vauban
 
PDF
What-Every-Tech-Leader-Needs-to-Know-About-AI-in-2025.pdf
byrishabhxbohra
 
PDF
GemTalk Systems LLC Growing the Business
byPijushSinha3
 
PDF
Postmates Clone App Delivery Service Business Solution.pdf
byV3CUBE TECHNOLABS
 
PDF
Introduction to Microsoft 365 Security and Compliance.pdf
byjohnsonsouza5
 
PDF
V3Cube Innovating Digital Business Solutions
byV3CUBE TECHNOLABS
 
PDF
Malware_Detection_A_Framework_for_Reverse_Engineered_Android_Applications_Thr...
byKiritiyadavGoskula
 
PPTX
wAIred_RabobankWRProducts__22012026.pptx
bySimonedeGijt
 
PDF
contusion pulmonar y antibiotico en el atls
byMARIAPETRONILAMONTAO
 
PPTX
Anomalies in Relational Database Management systems.pptx
byamutham12
 
PDF
09920-2 JE40CP MB 48.4GY02.021 Schematic Acer Aspire 4741.pdf
bydakjuel1
 
apidays Australia 2025 | Hey man, which one will deploy much faster, API or kid?
byapidays
 
apidays Australia 2025 | APIs in Government: A blueprint to automating Busine...
byapidays
 
apidays Australia 2025 | The API Platform as an Agentic Buffet: Serving APIs,...
byapidays
 
apidays Australia 2025 | Designing with workflows: Using Arazzo and OpenAPI f...
byapidays
 
Gojek Clone Business Strategy: From Launch to Scale
byV3CUBE TECHNOLABS
 
How to find your event photos instantly with a selfie using SnapSeek
bySnapSeek.app
 
A Complete Guide to Progressive Web App and Their Development
byMaxtra Technologies
 
Windows File System Monitoring Tool Using C and C++
byAkshay Muley
 
Own Your Domain Before It Owns You - Domain Driven Design for Pragmaticians
byPosedio GmbH
 
🤖🧰 SPRING AI AGENTIC PATTERNS (PART 1): AGENT SKILLS
byVincent Vauban
 
What-Every-Tech-Leader-Needs-to-Know-About-AI-in-2025.pdf
byrishabhxbohra
 
GemTalk Systems LLC Growing the Business
byPijushSinha3
 
Postmates Clone App Delivery Service Business Solution.pdf
byV3CUBE TECHNOLABS
 
Introduction to Microsoft 365 Security and Compliance.pdf
byjohnsonsouza5
 
V3Cube Innovating Digital Business Solutions
byV3CUBE TECHNOLABS
 
Malware_Detection_A_Framework_for_Reverse_Engineered_Android_Applications_Thr...
byKiritiyadavGoskula
 
wAIred_RabobankWRProducts__22012026.pptx
bySimonedeGijt
 
contusion pulmonar y antibiotico en el atls
byMARIAPETRONILAMONTAO
 
Anomalies in Relational Database Management systems.pptx
byamutham12
 
09920-2 JE40CP MB 48.4GY02.021 Schematic Acer Aspire 4741.pdf
bydakjuel1
 

How To Webinar - Sumo Logic API

  • 1.
    Sumo Logic Confidential SumoLogic API Welcome. You are currently in listen-only mode. To give everyone a chance to successfully connect, we’ll start at 10:05 AM Pacific. How-To Webinar Frank Reno, Customer Success March 2016
  • 2.
    Sumo Logic Confidential AvailableAPIs Performing Searches Managing Collectors Interacting with Dashboards (Beta)
  • 3.
    Sumo Logic Confidential GeneralAPI Details • Authentication – Initial request MUST include a HTTP Basic Authentication header using a username/password or access id/access key – API Authentications are limited to 15 calls per minute – Multiple requests should use cookies • The initial request will return a cookie containing two attributes: JSESSIONID and AWSELB. These can be included in subsequent requests to reduce the number of authentication calls.
  • 4.
    Sumo Logic Confidential •API requests are limited to 4 calls per second • Data Formats – All data is sent and received in JSON • API URL – Depends on your service region: General API Details Service URL API URL https://service.sumologic.com https://api.sumologic.com/api/v1/ https://service.us2.sumologic.com https://api.us2.sumologic.com/api/v1/ https://service.us4.sumologic.com https://api.us4.sumologic.com/api/v1/ https://service.eu.sumologic.com https://api.eu.sumologic.com/api/v1/ https://service.au.sumologic.com https://api.au.sumologic.com/api/v1/
  • 5.
    Sumo Logic Confidential •Errors – Errors are returned with an HTTP status code and JSON document. – General Error Codes • auth.failed – The authentication has failed • internal.error – Internal server error • unauthorized – Incorrect username/password • service.unavailable – The service is unavailable General API Details
  • 6.
    Sumo Logic Confidential •Ideal for fast, non-trivial queries • Synchronous • Limitations – Search must complete within 1 minute or it will timeout – A max of about 100K results will be returned. If you need more results, you will need to execute subsequent requests with smaller time rages or use the Search Job API. Search API
  • 7.
    Sumo Logic Confidential •Endpoint: /logs/search • Method: GET *Time range values can be specified in ISO 8601 format or epoch milliseconds. • https://api.sumologic.com/api/v1/logs/search?q=error&from=2012-04- 04T13:01:02&to=2012-04-04T15:01:02 Search API Parameter Required Default Description q Yes N/A The full search query to be executed. from No -15m Start of the time range. to No Now End of the time range. tz No Etc/UTC Time Zone format in TX format format No json The desired result format. Supported: json and text.
  • 8.
    Sumo Logic Confidential •Sample JSON Response Document Search API
  • 9.
    Sumo Logic Confidential Note: •This API may be deprecated in the future, in favor of the Search Job API. • Use the Search Job API where you can. Search API
  • 10.
    Sumo Logic Confidential •Models the asynchronous behavior of a search in the Sumo Logic backend – Creating a search job returns immediately with the ID for the search job. The ID can then be used to interact with the search job. • Provides histogram bucket information • Asynchronous • Limitations – The Search Job API does not have the limitations that the Search API has. Search Job API
  • 11.
    Sumo Logic Confidential •Endpoint: /search/jobs • Method: POST • Headers – Content-Type - application/json – Accept - application/json *Time rangevaluescan bespecifiedin ISO8601 formator epoch milliseconds. Search Job API - Creating a Search Job Parameter Type Required Description query String Yes The full search query to be executed. from String Yes Start of the time range to String Yes End of the time range timezone String Yes Time Zone format in TX format
  • 12.
    Sumo Logic Confidential •Status Codes • Response Headers • Sample JSON Response Document Search Job API - Creating a Search Job Status Code Text Description 202 Accepted The search job has been successfully created. 415 Unsupported Media Type Content-Type wasn't set to application/json. 400 Bad Request Generic request error by the client. Header Value Location https://api.sumologic.com/api/v1/search/jobs/SEARCH_JOB_ID
  • 13.
    Sumo Logic Confidential •Common Error Reasons – Query is not specified – Query is invalid – From/to parameters are not specified – To is before from time – From/to values invalid format – Time zone parameter missing • If any of the above occur, the response body will contain additional information. • Don’t forget to properly escape your query Search Job API - Creating a Search Job
  • 14.
    Sumo Logic Confidential •Endpoint: /search/jobs/SEARCH_JOB_ID • Method: GET Search Job API - Checking the status of a Search Job Sumo Logic Confidential14 Parameter Type Required Description SEARCH_JOB_ID String Yes The ID of the search job.
  • 15.
    Sumo Logic Confidential •Sample JSON Response Document • Possible States Search Job API - Checking the status of a Search Job State Description NOT STARTED Search job has not been started yet. GATHERING RESULTS Search job is still gathering more results, however results might already be available. DONE GATHERING RESULTS Search job is done gathering results; the entire specified time range has been covered. CANCELLED The search job has been cancelled.
  • 16.
    Sumo Logic Confidential •messageCount – The count of raw log messages • recordCount – The count of aggregates • If your search does not contain any aggregation operators, only the messageCount is returned. • pendingErrors, pendingWarnings and histogramBuckets ARE NOT cumulative – Each request will return the information found since the last request. The client will need to store these if they must be remembered. Search Job API - Checking the status of a Search Job
  • 17.
    Sumo Logic Confidential •Endpoint: /search/jobs/SEARCH_JOB_ID/messages?offset=OFFSET&limit=LIMIT • Method: GET *The maximumvalue forlimit is 10,000 messages Search Job API - Paging thru messages Parameter Required Description SEARCH_JOB_ID Yes The ID of the search job. OFFSET Yes Return messages starting at this offset. LIMIT Yes The number of messages starting at offsetto return.
  • 18.
    Sumo Logic Confidential •Sample JSON Response Document • The result will contain two lists – Fieldsis all the fieldsdefined for themessages – Messagescontainsa list of maps, onemap for each message Search Job API - Paging thru messages
  • 19.
    Sumo Logic Confidential •Endpoint: /search/jobs/SEARCH_JOB_ID/records?offset=OFFSET&limit=LIMIT • Method: GET *The maximumvalue forlimit is 10,000 messages Search Job API - Paging thru records Parameter Required Description SEARCH_JOB_ID Yes The ID of the search job. OFFSET Yes Return records starting at this offset. LIMIT Yes The number of records starting at offset to return.
  • 20.
    Sumo Logic Confidential •Sample JSON Response Document • The result will contain two lists – Fieldsis all the fieldsdefined for therecords – Recordscontainsa list of maps, onemap for each records Search Job API - Paging thru records
  • 21.
    Sumo Logic Confidential •Endpoint:/search/jobs/SEARCH_JOB_ID • Method: DELETE • Although search jobs ultimately timeout, it is best practice to delete a search job when it is no longer needed. Search Job API - Deleting a Search Job
  • 22.
  • 23.
    Sumo Logic Confidential •Java Client Library – Available on Maven Central – https://github.com/SumoLogic/sumo-java-client • Python Client Library – https://github.com/SumoLogic/sumologic-python-sdk Search Libraries
  • 24.
    Sumo Logic Confidential •Documentation – https://github.com/SumoLogic/sumo-api-doc/wiki – https://support.sumologic.com/hc/en-us/sections/200934938-APIs • Community Forum – https://support.sumologic.com/hc/communities/public/topics/200263058- Sumo-Logic-API • Email – api@sumologic.com API Resources