Skip to content

Commit 157fca5

Browse files
authored
DOCS-802 - Add API and Terraform course (#5596)
* Create 'About' section * Rough draft of API course article * Terraform rough draft * Cleanup * More cleanup * Final cleanup * Remove 'What are APIs?' sction * Update Terraform article * Fix spelling error
1 parent fe2ec28 commit 157fca5

File tree

120 files changed

+790
-142
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+790
-142
lines changed

blog-developer/2025-04-09-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ As previously communicated to impacted customers, effective as of April 30, 2025
88

99
Historical data will not be migrated to other deployments.
1010

11-
**Reminder**: If you're still referencing the India endpoint, please update your integrations. For supported alternatives, see the [endpoint guide](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security).
11+
**Reminder**: If you're still referencing the India endpoint, please update your integrations. For supported alternatives, see the [endpoint guide](/docs/api/about-apis/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security).
1212

1313
For help, contact [Support](https://support.sumologic.com/).

cid-redirects.json

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1406,9 +1406,9 @@
14061406
"/APIs/Field_Extraction_Rules_Management_API": "/docs/api/field-extraction-rules",
14071407
"/APIs/Field_Management_API": "/docs/api/field-management",
14081408
"/APIs/Folder_Management_API": "/docs/api/folder-management",
1409-
"/APIs/General-API-Information": "/docs/api/getting-started",
1410-
"/APIs/General-API-Information/Sumo-Logic-APIs": "/docs/api/getting-started",
1411-
"/APIs/General-API-Information/Sumo-Logic-APIs-Overview": "/docs/api/getting-started",
1409+
"/APIs/General-API-Information": "/docs/api/about-apis/getting-started",
1410+
"/APIs/General-API-Information/Sumo-Logic-APIs": "/docs/api/about-apis/getting-started",
1411+
"/APIs/General-API-Information/Sumo-Logic-APIs-Overview": "/docs/api/about-apis/getting-started",
14121412
"/APIs/Health_Events_Management_API": "/docs/api/health-events",
14131413
"/APIs/Lookup_Table_Management_API": "/docs/api/lookup-tables",
14141414
"/APIs/Lookup_API/Exporting_Lookup_Table_Data": "/docs/api/lookup-tables",
@@ -1418,17 +1418,17 @@
14181418
"/APIs/Metrics_Query_API": "/docs/api/metrics-query",
14191419
"/docs/api/ingest-budget-v1": "/docs/api/ingest-budget-v2",
14201420
"/APIs/Ingest_Budget_Management_API_V2": "/docs/api/ingest-budget-v2",
1421-
"/APIs/General-API-Information/API-Authentication": "/docs/api/getting-started",
1422-
"/APIs/General_API_Information/API_Authentication": "/docs/api/getting-started",
1423-
"/APIs/General-API-Information/API-Usage-Limits": "/docs/api/getting-started",
1424-
"/APIs/General_API_Information/Sumo_Logic_Endpoints": "/docs/api/getting-started",
1425-
"/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security": "/docs/api/getting-started",
1421+
"/APIs/General-API-Information/API-Authentication": "/docs/api/about-apis/getting-started",
1422+
"/APIs/General_API_Information/API_Authentication": "/docs/api/about-apis/getting-started",
1423+
"/APIs/General-API-Information/API-Usage-Limits": "/docs/api/about-apis/getting-started",
1424+
"/APIs/General_API_Information/Sumo_Logic_Endpoints": "/docs/api/about-apis/getting-started",
1425+
"/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security": "/docs/api/about-apis/getting-started",
14261426
"/Send_Data": "/docs/send-data",
14271427
"/Send_Data/Collector_Management_API/Sumo_Logic_Endpoints": "/docs/api/collector-management",
14281428
"/Send_Data/Collector_Management_API/About_the_Collector_Management_API": "/docs/api/collector-management",
14291429
"/Send_Data/Collector_FAQs/How_to_Ingest_Old_or_Historical_Data": "/docs/send-data/opentelemetry-collector/faq",
1430-
"/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security": "/docs/api/getting-started",
1431-
"/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security": "/docs/api/getting-started",
1430+
"/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security": "/docs/api/about-apis/getting-started",
1431+
"/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security": "/docs/api/about-apis/getting-started",
14321432
"/APIs/Partition_Management_API": "/docs/api/partition-management",
14331433
"/APIs/Password_Policy_Management_API": "/docs/api/password-policy",
14341434
"/APIs/Policies_Management_API": "/docs/api/policies-management",
@@ -1448,13 +1448,13 @@
14481448
"/APIs/Tracing_APIs/Service_Map_API": "/docs/api/tracing",
14491449
"/APIs/Tracing_APIs/Span_Analytics_API": "/docs/api/tracing",
14501450
"/APIs/Tracing_APIs/Traces_API": "/docs/api/tracing",
1451-
"/APIs/Troubleshooting-APIs": "/docs/api/troubleshooting",
1452-
"/APIs/Troubleshooting-APIs/API-301-Error-Moved": "/docs/api/troubleshooting",
1453-
"/APIs/Troubleshooting-APIs/API-401-Error-Credential-could-not-be-verified": "/docs/api/troubleshooting",
1454-
"/APIs/Troubleshooting-APIs/API-403-Error-This-operation-is-not-allowed-for-your-account-type": "/docs/api/troubleshooting",
1455-
"/APIs/Troubleshooting-APIs/Deployments-and-Sumo-Logic-Endpoints": "/docs/api/troubleshooting",
1456-
"/APIs/Troubleshooting-APIs/Receiving-500-errors-when-using-the-Search-Job-API": "/docs/api/troubleshooting",
1457-
"/APIs/Troubleshooting-APIs/Search-Job-API-Results-into-formatted-JSON-file": "/docs/api/troubleshooting",
1451+
"/APIs/Troubleshooting-APIs": "/docs/api/about-apis/troubleshooting",
1452+
"/APIs/Troubleshooting-APIs/API-301-Error-Moved": "/docs/api/about-apis/troubleshooting",
1453+
"/APIs/Troubleshooting-APIs/API-401-Error-Credential-could-not-be-verified": "/docs/api/about-apis/troubleshooting",
1454+
"/APIs/Troubleshooting-APIs/API-403-Error-This-operation-is-not-allowed-for-your-account-type": "/docs/api/about-apis/troubleshooting",
1455+
"/APIs/Troubleshooting-APIs/Deployments-and-Sumo-Logic-Endpoints": "/docs/api/about-apis/troubleshooting",
1456+
"/APIs/Troubleshooting-APIs/Receiving-500-errors-when-using-the-Search-Job-API": "/docs/api/about-apis/troubleshooting",
1457+
"/APIs/Troubleshooting-APIs/Search-Job-API-Results-into-formatted-JSON-file": "/docs/api/about-apis/troubleshooting",
14581458
"/APIs/User-Management-API": "/docs/api/user-management",
14591459
"/Archive": "/docs/release-notes",
14601460
"/Archive/Collector_Release_Notes_Archive": "/release-notes-collector",
@@ -2158,8 +2158,8 @@
21582158
"/cid/3008": "/docs/send-data/installed-collectors/sources/syslog-source",
21592159
"/cid/3009": "/docs/send-data/hosted-collectors/cloud-syslog-source",
21602160
"/cid/3010": "/docs/integrations/amazon-aws/threat-intel",
2161-
"/cid/3011": "/docs/api/getting-started",
2162-
"/cid/3012": "/docs/api/getting-started",
2161+
"/cid/3011": "/docs/api/about-apis/getting-started",
2162+
"/cid/3012": "/docs/api/about-apis/getting-started",
21632163
"/cid/3013": "/docs/manage/security/about-2-step-verification",
21642164
"/cid/3689": "/docs/send-data/collection/restart-collectors",
21652165
"/cid/4000": "/docs/send-data/collection/processing-rules",
@@ -3855,7 +3855,7 @@
38553855
"/APIs/02Search_Job_API": "/docs/api/search-job",
38563856
"/APIs/02Search_Job_API/About_the_Search_Job_API": "/docs/api/search-job",
38573857
"/APIs/02Search_Job_API/Search_Job_API_Reference": "/docs/api/search-job",
3858-
"/APIs/02Sumo-Logic-APIs/Deployment-Specific-Endpoints": "/docs/api/getting-started",
3858+
"/APIs/02Sumo-Logic-APIs/Deployment-Specific-Endpoints": "/docs/api/about-apis/getting-started",
38593859
"/APIs/03Search_Job_API": "/docs/api/search-job",
38603860
"/Apps/01_Apps_in_Sumo_Logic/Custom_Data_Filters": "/docs/get-started/apps-integrations",
38613861
"/Apps/02_Active_Directory_App": "/docs/integrations/microsoft-azure/active-directory-azure",
@@ -4419,7 +4419,8 @@
44194419
"/docs/integrations/microsoft-azure/active-directory-legacy": "/docs/integrations/microsoft-azure/active-directory-json",
44204420
"/docs/integrations/microsoft-azure/arm-integration-faq": "/docs/send-data/collect-from-other-data-sources/azure-monitoring/arm-integration-faq",
44214421
"/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-logs-azure-monitor": "/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/",
4422-
"/docs/reuse/fed-deployment-note": "/docs/api/getting-started",
4422+
"/docs/reuse/fed-deployment-note": "/docs/api/about-apis/getting-started",
4423+
"/docs/api/getting-started": "/docs/api/about-apis/getting-started",
44234424
"/docs/integrations/amazon-aws/aurora-mysql-ulm": "/docs/integrations/amazon-aws/rds",
44244425
"/docs/integrations/amazon-aws/aurora-postgresql-ulm": "/docs/integrations/amazon-aws/rds",
44254426
"/docs/integrations/amazon-aws/elastic-load-balancer-app": "/docs/integrations/amazon-aws/application-load-balancer",

docs/alerts/webhook-connections/cloud-soar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ You can configure a webhook connection to allow you to send an alert from a sche
2121
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Connections**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Monitoring** select **Connections**. You can also click the **Go To...** menu at the top of the screen and select **Connections**.
2222
1. Click **+** and choose **Cloud SOAR** as the connection type. The **Create Cloud SOAR Connection** dialog is displayed.<br/><img src={useBaseUrl('img/cloud-soar/CSOAR-connection1.png')} alt="New connection" style={{border: '1px solid gray'}} width="600"/>
2323
1. Enter a **Name** and give an optional **Description** to the connection.
24-
1. The **URL** field shows your [Sumo Logic API endpoint](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security) followed by `/csoar/v3/incidents/`. For example, `https://api.us2.sumologic.com/api/csoar/v3/incidents/`
25-
1. In **Authorization Header**, enter your basic authentication access information for the header. For example, `Basic <base64 encode <accessId>:<accessKey>>`. For more information, see [Basic Access (Base64 encoded)](/docs/api/getting-started#basic-access-base64-encoded).
24+
1. The **URL** field shows your [Sumo Logic API endpoint](/docs/api/about-apis/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security) followed by `/csoar/v3/incidents/`. For example, `https://api.us2.sumologic.com/api/csoar/v3/incidents/`
25+
1. In **Authorization Header**, enter your basic authentication access information for the header. For example, `Basic <base64 encode <accessId>:<accessKey>>`. For more information, see [Basic Access (Base64 encoded)](/docs/api/about-apis/getting-started#basic-access-base64-encoded).
2626
1. Click **Save**. After save, the **Templates** dropdown shows a list of all incident templates by name configured in your Cloud SOAR environment.
2727
1. Select a **Template**.
2828
1. The default payload synchronizes with the selected template, and the **Alert Payload** field shows the associated `template_id` field automatically defined in the default payload. A `template_id` is required in the payload in order to configure the connection:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Sumo Logic's FedRAMP deployment is similar to our other deployments, such as US2
132132

133133
### AWS region by Sumo Logic deployment
134134

135-
import AWSDeploymentRegion from '../reuse/aws-region-by-sumo-deployment.md';
135+
import AWSDeploymentRegion from '../../reuse/aws-region-by-sumo-deployment.md';
136136

137137
* <AWSDeploymentRegion/>
138138

@@ -142,9 +142,9 @@ Generic status codes that apply to all our APIs. See the [HTTP status code regis
142142

143143
| HTTP Status Code | Error Code | Description
144144
|:------------------|:---------------------|:-------------------------------------|
145-
| 301 | moved | The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](/docs/api/troubleshooting) for details. |
145+
| 301 | moved | The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](/docs/api/about-apis/troubleshooting) for details. |
146146
| 401 | unauthorized | Credential could not be verified. |
147-
| 403 | forbidden | This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](/docs/api/troubleshooting) for details. |
147+
| 403 | forbidden | This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](/docs/api/about-apis/troubleshooting) for details. |
148148
| 404 | notfound | Requested resource could not be found. |
149149
| 405 | method.unsupported | Unsupported method for URL. |
150150
| 415 | contenttype.invalid | Invalid content type. |

docs/api/about-apis/index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
slug: /api/about-apis
3+
title: About Sumo Logic APIs
4+
sidebar: About
5+
description: Learn about Sumo Logic APIs, including endpoints and how to use them.
6+
---
7+
8+
import useBaseUrl from '@docusaurus/useBaseUrl';
9+
10+
This section contains articles about how to use the Sumo Logic APIs.
11+
12+
13+
<div className="box-wrapper" markdown="1">
14+
<div className="box smallbox card">
15+
<div className="container">
16+
<a href="/docs/api/about-apis/intro-to-apis"><img src={useBaseUrl('img/icons/operations/advanced-certificates.png')} alt="Thumbnail icon" width="50"/><h4>Introduction to Sumo Logic APIs</h4></a>
17+
<p>Learn how to get started with the Sumo Logic APIs.</p>
18+
</div>
19+
</div>
20+
<div className="box smallbox card">
21+
<div className="container">
22+
<a href="/docs/api/about-apis/getting-started"><img src={useBaseUrl('img/icons/cloud/api2.png')} alt="icon" width="50"/><h4>Authentication and Endpoints</h4></a>
23+
<p>Get your API credentials and endpoint URL to start using the Sumo Logic APIs.</p>
24+
</div>
25+
</div>
26+
<div className="box smallbox card">
27+
<div className="container">
28+
<a href="/docs/api/about-apis/terraform-with-sumo-logic"><img src={useBaseUrl('img/api/terraform-icon.png')} alt="Thumbnail icon" width="50"/><h4>Use Terraform with Sumo Logic</h4></a>
29+
<p>Learn how to use Terraform with Sumo Logic.</p>
30+
</div>
31+
</div>
32+
<div className="box smallbox card">
33+
<div className="container">
34+
<a href="/docs/api/about-apis/troubleshooting"><img src={useBaseUrl('img/icons/operations/troubleshoot.png')} alt="Thumbnail icon" width="50"/><h4>Troubleshooting</h4></a>
35+
<p>Troubleshoot errors you may find when using the Sumo APIs.</p>
36+
</div>
37+
</div>
38+
</div>

0 commit comments

Comments
 (0)