DOCS-802 - Add API and Terraform course

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

@@ -8,6 +8,6 @@ As previously communicated to impacted customers, effective as of April 30, 2025
 
 Historical data will not be migrated to other deployments.
 
-**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).
+**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).
 
 For help, contact [Support](https://support.sumologic.com/).

cid-redirects.json

@@ -1403,9 +1403,9 @@
   "/APIs/Field_Extraction_Rules_Management_API": "/docs/api/field-extraction-rules",
   "/APIs/Field_Management_API": "/docs/api/field-management",
   "/APIs/Folder_Management_API": "/docs/api/folder-management",
-  "/APIs/General-API-Information": "/docs/api/getting-started",
-  "/APIs/General-API-Information/Sumo-Logic-APIs": "/docs/api/getting-started",
-  "/APIs/General-API-Information/Sumo-Logic-APIs-Overview": "/docs/api/getting-started",
+  "/APIs/General-API-Information": "/docs/api/about-apis/getting-started",
+  "/APIs/General-API-Information/Sumo-Logic-APIs": "/docs/api/about-apis/getting-started",
+  "/APIs/General-API-Information/Sumo-Logic-APIs-Overview": "/docs/api/about-apis/getting-started",
   "/APIs/Health_Events_Management_API": "/docs/api/health-events",
   "/APIs/Lookup_Table_Management_API": "/docs/api/lookup-tables",
   "/APIs/Lookup_API/Exporting_Lookup_Table_Data": "/docs/api/lookup-tables",
@@ -1415,17 +1415,17 @@
   "/APIs/Metrics_Query_API": "/docs/api/metrics-query",
   "/docs/api/ingest-budget-v1": "/docs/api/ingest-budget-v2",
   "/APIs/Ingest_Budget_Management_API_V2": "/docs/api/ingest-budget-v2",
-  "/APIs/General-API-Information/API-Authentication": "/docs/api/getting-started",
-  "/APIs/General_API_Information/API_Authentication": "/docs/api/getting-started",
-  "/APIs/General-API-Information/API-Usage-Limits": "/docs/api/getting-started",
-  "/APIs/General_API_Information/Sumo_Logic_Endpoints": "/docs/api/getting-started",
-  "/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security": "/docs/api/getting-started",
+  "/APIs/General-API-Information/API-Authentication": "/docs/api/about-apis/getting-started",
+  "/APIs/General_API_Information/API_Authentication": "/docs/api/about-apis/getting-started",
+  "/APIs/General-API-Information/API-Usage-Limits": "/docs/api/about-apis/getting-started",
+  "/APIs/General_API_Information/Sumo_Logic_Endpoints": "/docs/api/about-apis/getting-started",
+  "/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security": "/docs/api/about-apis/getting-started",
   "/Send_Data": "/docs/send-data",
   "/Send_Data/Collector_Management_API/Sumo_Logic_Endpoints": "/docs/api/collector-management",
   "/Send_Data/Collector_Management_API/About_the_Collector_Management_API": "/docs/api/collector-management",
   "/Send_Data/Collector_FAQs/How_to_Ingest_Old_or_Historical_Data": "/docs/send-data/opentelemetry-collector/faq",
-  "/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security": "/docs/api/getting-started",
-  "/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security": "/docs/api/getting-started",
+  "/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security": "/docs/api/about-apis/getting-started",
+  "/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security": "/docs/api/about-apis/getting-started",
   "/APIs/Partition_Management_API": "/docs/api/partition-management",
   "/APIs/Password_Policy_Management_API": "/docs/api/password-policy",
   "/APIs/Policies_Management_API": "/docs/api/policies-management",
@@ -1445,13 +1445,13 @@
   "/APIs/Tracing_APIs/Service_Map_API": "/docs/api/tracing",
   "/APIs/Tracing_APIs/Span_Analytics_API": "/docs/api/tracing",
   "/APIs/Tracing_APIs/Traces_API": "/docs/api/tracing",
-  "/APIs/Troubleshooting-APIs": "/docs/api/troubleshooting",
-  "/APIs/Troubleshooting-APIs/API-301-Error-Moved": "/docs/api/troubleshooting",
-  "/APIs/Troubleshooting-APIs/API-401-Error-Credential-could-not-be-verified": "/docs/api/troubleshooting",
-  "/APIs/Troubleshooting-APIs/API-403-Error-This-operation-is-not-allowed-for-your-account-type": "/docs/api/troubleshooting",
-  "/APIs/Troubleshooting-APIs/Deployments-and-Sumo-Logic-Endpoints": "/docs/api/troubleshooting",
-  "/APIs/Troubleshooting-APIs/Receiving-500-errors-when-using-the-Search-Job-API": "/docs/api/troubleshooting",
-  "/APIs/Troubleshooting-APIs/Search-Job-API-Results-into-formatted-JSON-file": "/docs/api/troubleshooting",
+  "/APIs/Troubleshooting-APIs": "/docs/api/about-apis/troubleshooting",
+  "/APIs/Troubleshooting-APIs/API-301-Error-Moved": "/docs/api/about-apis/troubleshooting",
+  "/APIs/Troubleshooting-APIs/API-401-Error-Credential-could-not-be-verified": "/docs/api/about-apis/troubleshooting",
+  "/APIs/Troubleshooting-APIs/API-403-Error-This-operation-is-not-allowed-for-your-account-type": "/docs/api/about-apis/troubleshooting",
+  "/APIs/Troubleshooting-APIs/Deployments-and-Sumo-Logic-Endpoints": "/docs/api/about-apis/troubleshooting",
+  "/APIs/Troubleshooting-APIs/Receiving-500-errors-when-using-the-Search-Job-API": "/docs/api/about-apis/troubleshooting",
+  "/APIs/Troubleshooting-APIs/Search-Job-API-Results-into-formatted-JSON-file": "/docs/api/about-apis/troubleshooting",
   "/APIs/User-Management-API": "/docs/api/user-management",
   "/Archive": "/docs/release-notes",
   "/Archive/Collector_Release_Notes_Archive": "/release-notes-collector",
@@ -2152,8 +2152,8 @@
   "/cid/3008": "/docs/send-data/installed-collectors/sources/syslog-source",
   "/cid/3009": "/docs/send-data/hosted-collectors/cloud-syslog-source",
   "/cid/3010": "/docs/integrations/amazon-aws/threat-intel",
-  "/cid/3011": "/docs/api/getting-started",
-  "/cid/3012": "/docs/api/getting-started",
+  "/cid/3011": "/docs/api/about-apis/getting-started",
+  "/cid/3012": "/docs/api/about-apis/getting-started",
   "/cid/3013": "/docs/manage/security/about-2-step-verification",
   "/cid/3689": "/docs/send-data/collection/restart-collectors",
   "/cid/4000": "/docs/send-data/collection/processing-rules",
@@ -3847,7 +3847,7 @@
   "/APIs/02Search_Job_API": "/docs/api/search-job",
   "/APIs/02Search_Job_API/About_the_Search_Job_API": "/docs/api/search-job",
   "/APIs/02Search_Job_API/Search_Job_API_Reference": "/docs/api/search-job",
-  "/APIs/02Sumo-Logic-APIs/Deployment-Specific-Endpoints": "/docs/api/getting-started",
+  "/APIs/02Sumo-Logic-APIs/Deployment-Specific-Endpoints": "/docs/api/about-apis/getting-started",
   "/APIs/03Search_Job_API": "/docs/api/search-job",
   "/Apps/01_Apps_in_Sumo_Logic/Custom_Data_Filters": "/docs/get-started/apps-integrations",
   "/Apps/02_Active_Directory_App": "/docs/integrations/microsoft-azure/active-directory-azure",
@@ -4407,7 +4407,8 @@
   "/docs/integrations/microsoft-azure/active-directory-legacy": "/docs/integrations/microsoft-azure/active-directory-json",
   "/docs/integrations/microsoft-azure/arm-integration-faq": "/docs/send-data/collect-from-other-data-sources/azure-monitoring/arm-integration-faq",
   "/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/",
-  "/docs/reuse/fed-deployment-note": "/docs/api/getting-started",
+  "/docs/reuse/fed-deployment-note": "/docs/api/about-apis/getting-started",
+  "/docs/api/getting-started": "/docs/api/about-apis/getting-started",
   "/docs/integrations/amazon-aws/aurora-mysql-ulm": "/docs/integrations/amazon-aws/rds",
   "/docs/integrations/amazon-aws/aurora-postgresql-ulm": "/docs/integrations/amazon-aws/rds",
   "/docs/integrations/amazon-aws/elastic-load-balancer-app": "/docs/integrations/amazon-aws/application-load-balancer",

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

@@ -21,8 +21,8 @@ You can configure a webhook connection to allow you to send an alert from a sche
 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**. 
 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"/>
 1. Enter a **Name** and give an optional **Description** to the connection.
-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/`
-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).
+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/`
+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).
 1. Click **Save**. After save, the **Templates** dropdown shows a list of all incident templates by name configured in your Cloud SOAR environment.
 1. Select a **Template**.
 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 → docs/api/about-apis/getting-started.md

@@ -132,7 +132,7 @@ Sumo Logic's FedRAMP deployment is similar to our other deployments, such as US2
 
 ### AWS region by Sumo Logic deployment
 
-import AWSDeploymentRegion from '../reuse/aws-region-by-sumo-deployment.md';
+import AWSDeploymentRegion from '../../reuse/aws-region-by-sumo-deployment.md';
 
 * <AWSDeploymentRegion/>
 
@@ -142,9 +142,9 @@ Generic status codes that apply to all our APIs. See the [HTTP status code regis
 
 | HTTP Status Code | Error Code          | Description                 
 |:------------------|:---------------------|:-------------------------------------|
-| 301              | moved               | The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](/docs/api/troubleshooting) for details.                                       |
+| 301              | moved               | The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](/docs/api/about-apis/troubleshooting) for details.                                       |
 | 401              | unauthorized        | Credential could not be verified.                                                                                                                                                      |
-| 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. |
+| 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. |
 | 404              | notfound            | Requested resource could not be found.                                                                                                                                                 |
 | 405              | method.unsupported  | Unsupported method for URL.                                                                                                                                                            |
 | 415              | contenttype.invalid | Invalid content type.                                                                                                                                                                  |

docs/api/about-apis/index.md

@@ -0,0 +1,38 @@
+---
+slug: /api/about-apis
+title: About Sumo Logic APIs
+sidebar: About
+description: Learn about Sumo Logic APIs, including endpoints and how to use them.
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+This section contains articles about how to use the Sumo Logic APIs.
+
+
+<div className="box-wrapper" markdown="1">
+<div className="box smallbox card">
+  <div className="container">
+  <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>
+  <p>Learn how to get started with the Sumo Logic APIs.</p>
+  </div>
+</div>
+<div className="box smallbox card">
+  <div className="container">
+  <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>
+  <p>Get your API credentials and endpoint URL to start using the Sumo Logic APIs.</p>
+  </div>
+</div>
+<div className="box smallbox card">
+  <div className="container">
+  <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>
+  <p>Learn how to use Terraform with Sumo Logic.</p>
+  </div>
+</div>
+<div className="box smallbox card">
+  <div className="container">
+  <a href="/docs/api/about-apis/troubleshooting"><img src={useBaseUrl('img/icons/operations/troubleshoot.png')} alt="Thumbnail icon" width="50"/><h4>Troubleshooting</h4></a>
+  <p>Troubleshoot errors you may find when using the Sumo APIs.</p>
+  </div>
+</div>
+</div>