Skip to content

Commit 6dd3f60

Browse files
authored
DOCS-1016 - Suggested edits (#5697)
* Suggested edits - Intro to APIs * Update docs/api/about-apis/intro-to-apis.md * Update docs/api/about-apis/intro-to-apis.md * Update docs/api/about-apis/intro-to-apis.md * Update docs/api/about-apis/intro-to-apis.md * Update docs/api/about-apis/intro-to-apis.md * Update docs/api/about-apis/intro-to-apis.md * Update docs/api/about-apis/intro-to-apis.md
1 parent 8b1fc9c commit 6dd3f60

File tree

6 files changed

+13
-12
lines changed

6 files changed

+13
-12
lines changed

docs/api/about-apis/intro-to-apis.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99

1010
<img src={useBaseUrl('img/icons/operations/advanced-certificates.png')} alt="Thumbnail icon" width="50"/>
1111

12-
Sumo Logic has a host of useful APIs across all products that can add valuable functionality to any organization by providing access to data and activities without going through the website. API calls can be used for data gathering, automation of processes, and custom reports.
12+
Sumo Logic has a host of useful APIs across all products that let you access data and perform actions without using the Sumo Logic UI. API calls can be used for to gather data, automate processes, and create custom reports.
1313

14-
This article presumes that you have a solid understanding of Sumo Logic functionality: collectors, queries, security offerings, etc. While APIs are typically for "power users" looking for additional customization and access to web service resources, you also don't need a computer science degree to understand and make use of API calls. This article helps walk you through the basics and get you going with important data queries through the API.
14+
This article is for users who are familiar with Sumo Logic features (collectors, queries, and security tools, for example), but new to working with APIs. You dont need a development background to follow along. We’ll cover the basics so you can start making API calls to run queries and perform tasks.
1515

16-
In this article, you'll learn about:
17-
* How to create a Sumo Logic access ID/key.
18-
* How to access Sumo Logic APIs.
19-
* How to use APIs with Sumo Logic's Cloud SIEM.
16+
In this article, you'll learn how to:
17+
18+
* Create a Sumo Logic access ID/key.
19+
* Access Sumo Logic APIs.
20+
* Use APIs with Sumo Logic's Cloud SIEM.
2021

2122
## Create an access key
2223

@@ -66,11 +67,9 @@ However, most API users do not use a traditional web browser for API calls, othe
6667
An open source application such as [Postman](https://www.postman.com/) can be a convenient tool for testing and developing with API calls. To use Postman, download and install the app. Then:
6768
1. Enter the URL for the API call.
6869
1. Click the **Authorization** tab.
69-
1. Fill in the username and password fields with your Sumo Logic access ID and access key respectively.
70+
1. Fill in the username and password fields with your Sumo Logic access ID and access key, respectively.
7071
1. Click **Send** when finished.
71-
1. You see the JSON output (or error messages if there is a problem) in the bottom panel.
72-
73-
<img src={useBaseUrl('img/api/postman-ui.png')} alt="Postman UI" style={{border: '1px solid gray'}} width="800" />
72+
1. You see the JSON output (or error messages if there is a problem) in the bottom panel.<br/><img src={useBaseUrl('img/api/postman-ui.png')} alt="Postman UI" style={{border: '1px solid gray'}} width="800" />
7473

7574
Most programming and scripting languages provide modules and libraries for making web service and API calls in code. For instance, the following Python code can make the same "get collectors" call programmatically using the `requests` library:
7675

@@ -128,7 +127,9 @@ Note the first ID from your list or the sample ID shown above from the Sumo Logi
128127

129128
<img src={useBaseUrl('img/api/collector-id.png')} alt="Collector ID" style={{border: '1px solid gray'}} width="800" />
130129

131-
Note that the collector data itself also contains a helpful follow-up link to analyze the sources currently configured for our chosen collector. Follow up by clicking on (or copying into the URL field) the given URL for sources: `https://api.sumologic.com/api/v1/collectors/<collectorID>/sources`
130+
Note that the collector data itself also contains a helpful follow-up link to analyze the sources currently configured for our chosen collector. Follow up by clicking on (or copying into the URL field) the given URL for sources:
131+
132+
`https://api.sumologic.com/api/v1/collectors/<collectorID>/sources`
132133

133134
<img src={useBaseUrl('img/api/collector-sources.png')} alt="Collector sources" style={{border: '1px solid gray'}} width="800" />
134135

@@ -365,4 +366,4 @@ Or add a new comment to an existing insight by creating comment text in the requ
365366

366367
<img src={useBaseUrl('img/api/insight-comment.png')} alt="Insight comment" style={{border: '1px solid gray'}} width="800" />
367368

368-
All elements of Cloud SIEM functionality are available through the API, including rules, match lists, automations, tags, and custom actions. Users can even use the API to generate their own insights based on a custom selection of signals.
369+
All elements of Cloud SIEM functionality are available through the API, including rules, match lists, automations, tags, and custom actions. Users can even use the API to generate their own insights based on a custom selection of signals.
-5.92 KB
Loading
-4.48 KB
Loading

static/img/api/imported-api.png

-2.74 KB
Loading

static/img/api/postman-ui.png

-13.2 KB
Loading

static/img/api/user-record.png

-2.61 KB
Loading

0 commit comments

Comments
 (0)