APIs
Use our Application Programming Interfaces (APIs) to interact with the Sumo Logic platform. To connect with other Sumo Logic users, post feedback, or ask a question, visit the Sumo Logic Community Integrate APIs Forum and Sumo Dojo.
General API Information
-
- API Authentication
- Sumo Logic supports API authentication by access ID and key.
-
- Sumo Logic Endpoints and Firewall Security
- Sumo Logic has several deployments, or pods, that are assigned depending on the geographic location and the date an account is created.
-
- Troubleshooting APIs
- This guide provides information to help you troubleshoot errors you may find when using Sumo APIs.
Documentation
Documentation for OpenAPI built APIs is hosted on each deployment. Sumo Logic has several deployments that are assigned depending on the geographic location and the date an account is created. See how to determine which endpoint to use if you are unsure.
Select the documentation link for your deployment:
APIs
- Access Keys Management API
- Use HTTP endpoints to manage access keys.
- Account Management API
- Use HTTP endpoints to manage subdomains.
- Archive Ingestion Management API
- Use HTTP endpoints to manage Archive ingestion jobs.
- Collector Management API
- The Collector Management API gives you the ability to manage Collectors and Sources from HTTP endpoints.
- Content Management API
- The Content Management API allows you to manage content in your organization’s Library from HTTP endpoints.
- Content Permissions API
- Use HTTP endpoints to manage content permissions.
- Dashboard (New) Management API
- Use HTTP endpoints to create and manage dashboards with the Dashboard (New) platform.
- Dynamic Parsing Management API
- The Dynamic Parsing Management API allows you to configure Run Time Field Extraction Rules from HTTP endpoints.
- Field Extraction Rules Management API
- Use HTTP endpoints to configure Field Extraction Rules.
- Field Management API
- Use HTTP endpoints to manage your account's field table schema.
- Folder Management API
- Use HTTP endpoints to manage folders in the Library.
- Health Events Management API
- Use HTTP endpoints to view your account's health events.
- Ingest Budget Management API
- The Ingest Budget Management API allows you to manage ingest budgets from HTTP endpoints.
- Ingest Budget Management API V2
- The Ingest Budget Management API V2 allows you to manage metadata-based ingest budgets (V2) from HTTP endpoints.
- Lookup Table Management API
- Use HTTP endpoints to manage Lookup Tables.
- Monitor Management API
- Use HTTP endpoints to manage your account's Monitors.
- Partition Management API
- Use HTTP endpoints to manage Partitions.
- Password Policy Management API
- Use HTTP endpoints to manage your account's password policy.
- Role Management API
- The Role Management API allows you to manage roles from HTTP endpoints.
- SAML Configuration Management API
- Use HTTP endpoints to manage your SAML configuration.
- Scheduled View Management API
- Use HTTP endpoints to manage Scheduled Views.
- Search Job API
- The Search Job API provides access to resources and log data from third-party scripts and applications. The API follows Representational State Transfer (REST) patterns and is optimized for ease of use and consistency.
- Service Allowlist Management API
- Use HTTP endpoints to manage service allowlist settings.
- Tokens Management API
- Use HTTP endpoints to manage Installation Tokens.
- User Management API
- The User Management API allows you to manage user accounts from HTTP endpoints.
- Tracing APIs
- The Tracing APIs give you the ability to browse and execute queries for traces and span analytics, and request a service map of your application environment.