Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/about-apis/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Sumo Logic APIs follow Representational State Transfer (REST) patterns and are o

## Documentation

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).
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)

| Deployment | API Docs URL |
| Deployment | API documentation URL |
|:-----------|:----------------------------------|
| AU | https://api.au.sumologic.com/docs/ |
| CA | https://api.ca.sumologic.com/docs/ |
Expand Down
12 changes: 12 additions & 0 deletions docs/api/about-apis/intro-to-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ if __name__ == '__main__':

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.

### Download the OpenAPI Specification

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:

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/.
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" />
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**.
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" />
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:
* [Cloud SIEM API documentation](/docs/api/cloud-siem-enterprise/#documentation)
* [Cloud SOAR API documentation](/docs/api/cloud-soar/#documentation)

## Basic API GET commands

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/reuse/api-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ To get started with Sumo Logic APIs, see [API Authentication, Endpoints, and Sec

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

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)
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)
2 changes: 1 addition & 1 deletion docs/reuse/cse-api-table.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| Deployment | Documentation URL |
| Deployment | API documentation URL |
|:-----------|:----------------------------------------------------------|
| AU | https://api.au.sumologic.com/docs/sec/ |
| CA | https://api.ca.sumologic.com/docs/sec/ |
Expand Down
2 changes: 1 addition & 1 deletion docs/reuse/csoar-api-table.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| Deployment | Documentation URL |
| Deployment | API documentation URL |
|:-----------|:----------------------------------------------------------|
| AU | https://api.au.sumologic.com/docs/csoar/ |
| CA | https://api.ca.sumologic.com/docs/csoar/ |
Expand Down
Binary file added static/img/api/imported-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/api/openapi-spec-download-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.