Skip to content

Commit 9f611db

Browse files
committed
Add new section
1 parent 51096a7 commit 9f611db

File tree

7 files changed

+17
-5
lines changed

7 files changed

+17
-5
lines changed

docs/api/about-apis/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Sumo Logic APIs follow Representational State Transfer (REST) patterns and are o
1515

1616
## Documentation
1717

18-
To view our main docs, click the link below corresponding to your deployment. If you're not sure, see [How to determine your endpoint](#which-endpoint-should-i-should-use).
18+
To access our API documentation, navigate to the appropriate link based on your Sumo Logic deployment. If you're not sure, see [Which endpoint should I use?](#which-endpoint-should-i-should-use)
1919

20-
| Deployment | API Docs URL |
20+
| Deployment | API documentation URL |
2121
|:-----------|:----------------------------------|
2222
| AU | https://api.au.sumologic.com/docs/ |
2323
| CA | https://api.ca.sumologic.com/docs/ |

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,18 @@ if __name__ == '__main__':
9898

9999
As you are learning how APIs work, we recommend setting up an API test program, then follow along with the API examples shown in the following sections. To execute API commands, you can use Postman as shown above, another API test application, or set up a quick code snippet in Python or the programming language of your choice.
100100

101+
### Download the OpenAPI Specification
102+
103+
You can download the OpenAPI Specification for the Sumo Logic API and import it to your API test application. This not only allows you to see the specification for all the Sumo Logic APIs, but to run them as well:
104+
105+
1. Select the API documentation URL for your deployment from the [Documentation](/docs/api/about-apis/getting-started/#documentation) section of the *API Authentication, Endpoints, and Security* article. For instance, US users would access either https://api.sumologic.com/docs/ or https://api.us2.sumologic.com/docs/.
106+
1. Click the **Download** button at the top of the page. <br/><img src={useBaseUrl('img/api/openapi-spec-download-button.png')} alt="Button to download Sumo Logic OpenAPI Specification" style={{border: '1px solid gray'}} width="600" />
107+
1. Import the downloaded file to your API test application. For example, to [import the file to Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data/), select **File > Import**.
108+
1. The imported specification appears. Select any API to run it.<br/><img src={useBaseUrl('img/api/imported-api.png')} alt="Imported API specification" style={{border: '1px solid gray'}} width="500" />
109+
1. You can also download the API specification for Cloud SIEM or Cloud SOAR from the following locations. Simply select the API documentation URL for your deployment and click the **Download** button at the top of the page:
110+
* [Cloud SIEM API documentation](/docs/api/cloud-siem-enterprise/#documentation)
111+
* [Cloud SOAR API documentation](/docs/api/cloud-soar/#documentation)
112+
101113
## Basic API GET commands
102114

103115
Retrieving system data and configuration is one of the most common use cases for utilizing platform APIs. These data retrieval operations are generally known as GET commands in reference to the "GET" verb used by the HTTP protocol. Data retrieved through API calls can be processed by outside applications and scripts for report generation and advanced analytics, extending functionality beyond that offered by the Sumo Logic website.

docs/reuse/api-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ To get started with Sumo Logic APIs, see [API Authentication, Endpoints, and Sec
22

33
Our APIs are built with [OpenAPI](https://www.openapis.org/). You can generate client libraries in several languages and explore automated testing.
44

5-
To access our API documentation, navigate to the appropriate link based on your Sumo deployment. Deployment types differ based on geographic location and account creation date. If unsure, see [Which endpoint should I use?](/docs/api/about-apis/getting-started#which-endpoint-should-i-should-use)
5+
To access our API documentation, navigate to the appropriate link based on your Sumo Logic deployment. Deployment types differ based on geographic location and account creation date. If unsure, see [Which endpoint should I use?](/docs/api/about-apis/getting-started#which-endpoint-should-i-should-use)

docs/reuse/cse-api-table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
| Deployment | Documentation URL |
1+
| Deployment | API documentation URL |
22
|:-----------|:----------------------------------------------------------|
33
| AU | https://api.au.sumologic.com/docs/sec/ |
44
| CA | https://api.ca.sumologic.com/docs/sec/ |

docs/reuse/csoar-api-table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
| Deployment | Documentation URL |
1+
| Deployment | API documentation URL |
22
|:-----------|:----------------------------------------------------------|
33
| AU | https://api.au.sumologic.com/docs/csoar/ |
44
| CA | https://api.ca.sumologic.com/docs/csoar/ |

static/img/api/imported-api.png

77.6 KB
Loading
76.1 KB
Loading

0 commit comments

Comments
 (0)