canonical: https://jentic.com/apis/api.us2.sumologic.com/sumologic

# Us2 Sumologic Sumo Logic API

Jentic publishes the only available OpenAPI specification for Sumo Logic API, keeping it validated and agent-ready. Sumo Logic is a cloud-native log management and observability platform; the API exposes account, content, dashboard, monitor, role, and app installation surfaces across more than 400 operations. Use it to install apps, manage monitors, run admin operations, and query the platform state without using the Sumo UI. Note that endpoint hostnames vary by deployment region - pick the correct base URL for your account.

## For AI agents

Install Sumo Logic apps, manage monitors and dashboards, and run admin operations across the observability platform through a 406-endpoint REST API.

## Scope

Does not handle log ingestion at the collector level, raw search-job streaming, or billing - use for app lifecycle, monitors, dashboards, and admin operations only.

## Capabilities

- Install a Sumo Logic app from the catalog and track the install job status
- Upgrade or uninstall a previously installed app version through the v2 lifecycle endpoints
- Manage monitors that page the on-call team when log signals breach a threshold
- Read and update dashboard, content, and folder hierarchies for ops teams managing many workspaces
- Provision roles and access controls so each team only sees the indices they own
- Inspect the install job history for an app to debug deployment regressions

## Use cases

### Programmatic App Rollout Across Workspaces

An observability team manages dozens of Sumo Logic accounts across business units. To roll out a new compliance app, an agent calls `/v2/apps/{uuid}/install` for each account, then polls `/v2/apps/install/{jobId}/status` until each install reports success. The standard UI rollout becomes a parallel programmatic batch.

Example prompt: POST `/v2/apps/{uuid}/install` for each target workspace, then GET `/v2/apps/install/{jobId}/status` until each install completes

### Monitor Lifecycle as Code

Engineering teams want their Sumo Logic monitors version-controlled rather than hand-edited. An agent reads the current monitor state, applies the diff from a Git change, and writes the updated definitions back through the API. The result is auditable, reviewable monitor changes.

Example prompt: List existing monitors, compute the diff against the desired-state YAML, and apply create or update calls per change

### App Upgrade and Rollback Automation

When an installed Sumo Logic app needs upgrading, an agent kicks off `/v2/apps/{uuid}/upgrade` and watches `/v2/apps/upgrade/{jobId}/status.` If the upgrade fails or downstream dashboards regress, the same agent calls `/v2/apps/{uuid}/uninstall` and reinstalls the previous known-good version.

Example prompt: POST `/v2/apps/{uuid}/upgrade`, watch the job status, and trigger uninstall plus reinstall on failure

### Admin Audit and Inventory of Installed Apps

A platform team running compliance reviews needs a periodic inventory of which Sumo Logic apps are installed where. An agent walks `/v1/apps` and `/v2/apps`, then fetches `/v2/apps/{uuid}/details` for each install. The output feeds a spreadsheet or dashboard the auditor can review.

Example prompt: List apps via `/v1/apps`, then for each installed app call `/v2/apps/{uuid}/details` and aggregate the inventory

### AI Agent Observability Operations via Jentic

An incident-response agent uses Jentic to drive Sumo Logic during a high-pressure incident. Searching by intent - 'install the AWS GuardDuty app' or 'list active monitors' - Jentic returns the right operation across the 400-plus surface so the agent can act without browsing the API reference.

Example prompt: Use Jentic to find the Sumo Logic app-install operation, execute it for the chosen app uuid, and confirm the install job completed

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/apps` | List apps available in the catalog |
| POST | `/v2/apps/{uuid}/install` | Install an app into a workspace |
| GET | `/v2/apps/install/{jobId}/status` | Check the status of an app install job |
| POST | `/v2/apps/{uuid}/upgrade` | Upgrade an installed app |
| POST | `/v2/apps/{uuid}/uninstall` | Uninstall an app |
| GET | `/v2/apps/{uuid}/details` | Retrieve details for an installed app |

## Key resources

- **Apps** — Sumo Logic catalog apps and their installation lifecycle
- **Install Jobs** — Asynchronous install, upgrade, and uninstall job tracking
- **Monitors** — Threshold-based alerts on log and metric signals
- **Dashboards and Content** — Visualisation and saved content management
- **Roles and Users** — Access control across workspaces

## Why Jentic

- **Setup:** Wiring Sumo Logic by hand means setting up its basic auth with an access id and key, picking the right regional deployment host from AU, CA, DE, EU, or US, and polling install jobs yourself. Through Jentic you install once, import Sumo Logic from the API Directory, store the access id and key once, and your agent calls it.
- **Permission scoping:** Sumo Logic puts the app uuid in the URL path (`/apps/{uuid}/...`), so a rule can pin your agent to one app: it can install and check status for that app and nothing else. You choose the operations it may call, so uninstall is not included unless you add it.
- **Credential handling:** Your Sumo Logic access id and key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'install a Sumo Logic app' or 'check an install job status', and Jentic returns the matching Sumo Logic operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Splunk** — Splunk covers similar log management and search territory to Sumo Logic, with a different deployment and licensing model.
- **New Relic** — New Relic emphasises full-stack APM alongside logs; Sumo Logic centres on log analytics and security observability.
- **Cloudflare** — Cloudflare ships logs that Sumo Logic ingests for security and traffic analysis.

## FAQ

### Why is there no official OpenAPI spec for Sumo Logic?

Sumo Logic does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Sumo Logic API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Sumo Logic API use?

Sumo Logic uses HTTP basic authentication. Provision an access ID and access key inside Sumo Logic, then send them as the basic-auth username and password. Through Jentic, both halves of the credential are held in your Jentic One instance and injected at execution time.

### Can I install a Sumo Logic app through the API?

Yes. POST `/v2/apps/{uuid}/install` starts an install job and returns a jobId. Poll `/v2/apps/install/{jobId}/status` until it reports success. The same v2 surface offers upgrade and uninstall lifecycle calls with their own job-status endpoints.

### What are the rate limits for the Sumo Logic API?

The spec does not declare numeric rate limits. Sumo Logic enforces tenant-level throttling; build agent calls with exponential backoff on 429 and avoid tight polling of install-job status - a few seconds between polls is sufficient.

### How do I install a Sumo Logic app through Jentic?

Install the SDK with `pip install jentic`. Search Jentic for `install a sumo logic app`, load the schema for POST `/v2/apps/{uuid}/install`, and execute it with the app uuid. Jentic returns the jobId so the agent can follow up with the status endpoint.

### Does the base URL change between regions?

Yes. Sumo Logic deployments are regional - the spec shows api.au.sumologic.com but the slug is api.us2.sumologic.com. Use the host that matches your tenant region (us1, us2, eu, au, etc.) and keep the path prefix /api/ on every call.

### Can I limit what my agent is allowed to do with the Sumo Logic API?

Yes. Because you run Jentic One yourself and define its rules, you decide exactly which Sumo Logic operations and credentials your agent may use. Since Sumo Logic carries the app uuid in the URL path, such as `/v2/apps/{uuid}/install`, you can pin the agent to a single app so it only installs that app and checks its install-job status through `/v2/apps/install/{jobId}/status.` Destructive calls like `/v2/apps/{uuid}/uninstall` stay off limits unless you explicitly grant them.