Skip to content

Commit ca01bfe

Browse files
authored
Merge branch 'main' into DOCS-1006
2 parents d6d8701 + e8141e4 commit ca01bfe

File tree

157 files changed

+1871
-366
lines changed

Some content is hidden

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

157 files changed

+1871
-366
lines changed

.clabot

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@
185185
"snyk-bot",
186186
"stephenthedev",
187187
"Apoorvkudesia-sumologic",
188-
"ntanwar-sumo"
188+
"ntanwar-sumo",
189+
"aj-sumo"
189190
],
190191
"message": "Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please [sign your name here](https://forms.gle/YgLddrckeJaCdZYA6) and we will add you to our approved list of contributors.",
191192
"label": "cla-signed",

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: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@
174174
"/03Send-Data/Collector-FAQs": "/docs/send-data/collector-faq",
175175
"/Send-Data/Collector-FAQs": "/docs/send-data/collector-faq",
176176
"/Send-Data/Collector-FAQs/How-can-I-tell-if-I'm-collecting-data": "/docs/send-data/collector-faq",
177+
"/Send-Data/Collector-FAQs/Troubleshooting-large-message-time-and-receipt-time-discrepancies": "/docs/send-data/collector-faq",
177178
"/03Send-Data/Collector-FAQs/Collector-fails-to-connect-to-Sumo%3A-Target-server-failed-to-respond-or-HTTP-504-or-HTTP-408-errors": "/docs/send-data/collector-faq",
178179
"/03Send-Data/Collector-FAQs/Collector-fails-to-connect-to-Sumo:-Target-server-failed-to-respond-or-HTTP-504-or-HTTP-408-errors": "/docs/send-data/collector-faq",
179180
"/03Send-Data/Collector-FAQs/Collector-locking-log-files-on-Windows-servers": "/docs/send-data/collector-faq",
@@ -1406,9 +1407,9 @@
14061407
"/APIs/Field_Extraction_Rules_Management_API": "/docs/api/field-extraction-rules",
14071408
"/APIs/Field_Management_API": "/docs/api/field-management",
14081409
"/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",
1410+
"/APIs/General-API-Information": "/docs/api/about-apis/getting-started",
1411+
"/APIs/General-API-Information/Sumo-Logic-APIs": "/docs/api/about-apis/getting-started",
1412+
"/APIs/General-API-Information/Sumo-Logic-APIs-Overview": "/docs/api/about-apis/getting-started",
14121413
"/APIs/Health_Events_Management_API": "/docs/api/health-events",
14131414
"/APIs/Lookup_Table_Management_API": "/docs/api/lookup-tables",
14141415
"/APIs/Lookup_API/Exporting_Lookup_Table_Data": "/docs/api/lookup-tables",
@@ -1418,17 +1419,17 @@
14181419
"/APIs/Metrics_Query_API": "/docs/api/metrics-query",
14191420
"/docs/api/ingest-budget-v1": "/docs/api/ingest-budget-v2",
14201421
"/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",
1422+
"/APIs/General-API-Information/API-Authentication": "/docs/api/about-apis/getting-started",
1423+
"/APIs/General_API_Information/API_Authentication": "/docs/api/about-apis/getting-started",
1424+
"/APIs/General-API-Information/API-Usage-Limits": "/docs/api/about-apis/getting-started",
1425+
"/APIs/General_API_Information/Sumo_Logic_Endpoints": "/docs/api/about-apis/getting-started",
1426+
"/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security": "/docs/api/about-apis/getting-started",
14261427
"/Send_Data": "/docs/send-data",
14271428
"/Send_Data/Collector_Management_API/Sumo_Logic_Endpoints": "/docs/api/collector-management",
14281429
"/Send_Data/Collector_Management_API/About_the_Collector_Management_API": "/docs/api/collector-management",
14291430
"/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",
1431+
"/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security": "/docs/api/about-apis/getting-started",
1432+
"/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security": "/docs/api/about-apis/getting-started",
14321433
"/APIs/Partition_Management_API": "/docs/api/partition-management",
14331434
"/APIs/Password_Policy_Management_API": "/docs/api/password-policy",
14341435
"/APIs/Policies_Management_API": "/docs/api/policies-management",
@@ -1440,6 +1441,7 @@
14401441
"/APIs/About-the-Search-Job-API": "/docs/api/search-job",
14411442
"/APIs/Search-Job-API/Search-Job-API-Overview": "/docs/api/search-job",
14421443
"/APIs/Search-Job-API/About-the-Search-Job-API": "/docs/api/search-job",
1444+
"/docs/api/search": "/docs/api/search-job",
14431445
"/docs/api/search/search-job-api": "/docs/api/search-job",
14441446
"/docs/api/search-jobs": "/docs/api/search-job",
14451447
"/APIs/Service_Allowlist_Management_API": "/docs/api/service-allowlist",
@@ -1448,13 +1450,14 @@
14481450
"/APIs/Tracing_APIs/Service_Map_API": "/docs/api/tracing",
14491451
"/APIs/Tracing_APIs/Span_Analytics_API": "/docs/api/tracing",
14501452
"/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",
1453+
"/docs/api/troubleshooting": "/docs/api/about-apis/troubleshooting",
1454+
"/APIs/Troubleshooting-APIs": "/docs/api/about-apis/troubleshooting",
1455+
"/APIs/Troubleshooting-APIs/API-301-Error-Moved": "/docs/api/about-apis/troubleshooting",
1456+
"/APIs/Troubleshooting-APIs/API-401-Error-Credential-could-not-be-verified": "/docs/api/about-apis/troubleshooting",
1457+
"/APIs/Troubleshooting-APIs/API-403-Error-This-operation-is-not-allowed-for-your-account-type": "/docs/api/about-apis/troubleshooting",
1458+
"/APIs/Troubleshooting-APIs/Deployments-and-Sumo-Logic-Endpoints": "/docs/api/about-apis/troubleshooting",
1459+
"/APIs/Troubleshooting-APIs/Receiving-500-errors-when-using-the-Search-Job-API": "/docs/api/about-apis/troubleshooting",
1460+
"/APIs/Troubleshooting-APIs/Search-Job-API-Results-into-formatted-JSON-file": "/docs/api/about-apis/troubleshooting",
14581461
"/APIs/User-Management-API": "/docs/api/user-management",
14591462
"/Archive": "/docs/release-notes",
14601463
"/Archive/Collector_Release_Notes_Archive": "/release-notes-collector",
@@ -2158,8 +2161,8 @@
21582161
"/cid/3008": "/docs/send-data/installed-collectors/sources/syslog-source",
21592162
"/cid/3009": "/docs/send-data/hosted-collectors/cloud-syslog-source",
21602163
"/cid/3010": "/docs/integrations/amazon-aws/threat-intel",
2161-
"/cid/3011": "/docs/api/getting-started",
2162-
"/cid/3012": "/docs/api/getting-started",
2164+
"/cid/3011": "/docs/api/about-apis/getting-started",
2165+
"/cid/3012": "/docs/api/about-apis/getting-started",
21632166
"/cid/3013": "/docs/manage/security/about-2-step-verification",
21642167
"/cid/3689": "/docs/send-data/collection/restart-collectors",
21652168
"/cid/4000": "/docs/send-data/collection/processing-rules",
@@ -3366,7 +3369,6 @@
33663369
"/Manage/Security/Set-the-Password-Policy": "/docs/manage/security/set-password-policy",
33673370
"/Manage/Threat-Intel-Ingest": "/docs/security/threat-intelligence",
33683371
"/docs/platform-services/threat-intelligence-indicators": "/docs/security/threat-intelligence",
3369-
"/docs/security/threat-intelligence/threat-intelligence-mapping": "/docs/security/threat-intelligence",
33703372
"/docs/manage/users/manage-access-keys": "/docs/manage/security/access-keys",
33713373
"/Manage/Users-and-Roles": "/docs/manage/users-roles",
33723374
"/Manage/Users-and-Roles/Manage-Roles": "/docs/manage/users-roles",
@@ -3803,6 +3805,8 @@
38033805
"/03Send-Data/Sources/01Sources-for-Installed-Collectors/Local_Windows_Event_Log_Source": "/docs/send-data/installed-collectors/sources/local-windows-event-log-source",
38043806
"/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services": "/docs/send-data/hosted-collectors/amazon-aws",
38053807
"/03Send-Data/Sources/04Reference-Information-for-Sources": "/docs/send-data/reference-information",
3808+
"/07Sumo_Logic_Apps/04Microsoft-and-Azure/Azure_Audit/02Collect-Logs-for-Azure-Audit-from-Event-Hub": "/docs/integrations/microsoft-azure/azure-event-hubs",
3809+
"/07Sumo_Logic_Apps/04Microsoft-and-Azure/Microsoft_Office_365": "/docs/integrations/microsoft-azure/office-365",
38063810
"/07Sumo_Logic_Apps/08App_Development/Jenkins": "/docs/integrations/app-development/jenkins",
38073811
"/07Sumo_Logic_Apps/08App_Development/Jenkins/Install_the_Jenkins_App_and_view_the_Dashboards": "/docs/integrations/app-development/jenkins",
38083812
"/07Sumo_Logic_Apps/08App_Development/Artifactory": "/docs/integrations/app-development/jfrog-artifactory",
@@ -3855,7 +3859,7 @@
38553859
"/APIs/02Search_Job_API": "/docs/api/search-job",
38563860
"/APIs/02Search_Job_API/About_the_Search_Job_API": "/docs/api/search-job",
38573861
"/APIs/02Search_Job_API/Search_Job_API_Reference": "/docs/api/search-job",
3858-
"/APIs/02Sumo-Logic-APIs/Deployment-Specific-Endpoints": "/docs/api/getting-started",
3862+
"/APIs/02Sumo-Logic-APIs/Deployment-Specific-Endpoints": "/docs/api/about-apis/getting-started",
38593863
"/APIs/03Search_Job_API": "/docs/api/search-job",
38603864
"/Apps/01_Apps_in_Sumo_Logic/Custom_Data_Filters": "/docs/get-started/apps-integrations",
38613865
"/Apps/02_Active_Directory_App": "/docs/integrations/microsoft-azure/active-directory-azure",
@@ -4099,6 +4103,7 @@
40994103
"/Send-Data/Applications-and-Other-Data-Sources/AWS_WAF/Collect_Logs_for_AWS_WAF": "/docs/integrations/amazon-aws/waf",
41004104
"/Send-Data/Applications-and-Other-Data-Sources/AWS-Lambda": "/docs/integrations/amazon-aws/lambda",
41014105
"/Send-Data/Applications-and-Other-Data-Sources/AWS-CloudTrail/04-Set-Up-Admin-Access-for-CloudTrail": "/docs/integrations/amazon-aws/cloudtrail",
4106+
"/Send-Data/Applications-and-Other-Data-Sources/AWS-Elastic-Load-Balancing-ULM-Application/Collect-Logs-and-Metrics-for-AWS-Elastic-Load-Balancing-ULM-Application": "/docs/integrations/amazon-aws/classic-load-balancer",
41024107
"/Send-Data/Applications-and-Other-Data-Sources/Azure_Active_Directory": "/docs/integrations/microsoft-azure/active-directory-azure",
41034108
"/Send-Data/Applications-and-Other-Data-Sources/Azure_Active_Directory/Collect_Logs_for_Azure_Active_Directory": "/docs/integrations/microsoft-azure/active-directory-azure",
41044109
"/Send-Data/Applications-and-Other-Data-Sources/Azure_Active_Directory/Install_the_Azure_Active_Directory_App_and_View_the_Dashboards": "/docs/integrations/microsoft-azure/active-directory-azure",
@@ -4175,6 +4180,7 @@
41754180
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-Syslog-Source": "/docs/send-data/hosted-collectors/cloud-syslog-source",
41764181
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-Syslog-Source/Install-syslog-ng": "/docs/send-data/hosted-collectors/cloud-syslog-source/install-syslog-ng",
41774182
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/Google-Cloud-Platform-Source": "/docs/send-data/hosted-collectors/google-source/google-cloud-platform-source",
4183+
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/Google-Apps-Audit-Source": "/docs/send-data/hosted-collectors/google-source/google-workspace-apps-audit-source",
41784184
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source": "/docs/send-data/hosted-collectors/http-source",
41794185
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source/Upload-Data-to-an-HTTP-Source": "/docs/send-data/hosted-collectors/http-source",
41804186
"/Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source/zGenerate-a-new-URL-for-an-HTTP-Source": "/docs/send-data/hosted-collectors/http-source",
@@ -4419,7 +4425,8 @@
44194425
"/docs/integrations/microsoft-azure/active-directory-legacy": "/docs/integrations/microsoft-azure/active-directory-json",
44204426
"/docs/integrations/microsoft-azure/arm-integration-faq": "/docs/send-data/collect-from-other-data-sources/azure-monitoring/arm-integration-faq",
44214427
"/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",
4428+
"/docs/reuse/fed-deployment-note": "/docs/api/about-apis/getting-started",
4429+
"/docs/api/getting-started": "/docs/api/about-apis/getting-started",
44234430
"/docs/integrations/amazon-aws/aurora-mysql-ulm": "/docs/integrations/amazon-aws/rds",
44244431
"/docs/integrations/amazon-aws/aurora-postgresql-ulm": "/docs/integrations/amazon-aws/rds",
44254432
"/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)