Service Map APIs
The Service Map API allows you to fetch a graph representation of the Service Map, which is a high-level view of your application environment, automatically derived from tracing data. For more information, see Service Map.
See also: Span Analytics APIs and Traces APIs.
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.
Documentation
To get started with Sumo Logic APIs, see API Authentication, Endpoints, and Security.
Our APIs are built with OpenAPI. You can generate client libraries in several languages and explore automated testing.
To access our API documentation, navigate to the appropriate link based on your Sumo Logic deployment. Deployment types differ based on geographic location and account creation date. If unsure, see Which endpoint should I use?
| Region code | Region name | AWS region | API endpoint |
|---|---|---|---|
| AU | Asia Pacific (Sydney) | ap-southeast-2 | https://api.au.sumologic.com/docs/#tag/serviceMap |
| CA | Canada (Central) | ca-central-1 | https://api.ca.sumologic.com/docs/#tag/serviceMap |
| CH | Switzerland (Zurich) | eu-central-2 | https://api.ch.sumologic.com/docs/#tag/serviceMap |
| DE | EU (Frankfurt) | eu-central-1 | https://api.de.sumologic.com/docs/#tag/serviceMap |
| EU | EU (Ireland) | eu-west-1 | https://api.eu.sumologic.com/docs/#tag/serviceMap |
| FED | US East (N. Virginia) | us-east-1 | https://api.fed.sumologic.com/docs/#tag/serviceMap |
| JP | Asia Pacific (Tokyo) | ap-northeast-1 | https://api.jp.sumologic.com/docs/#tag/serviceMap |
| KR | Asia Pacific (Seoul) | ap-northeast-2 | https://api.kr.sumologic.com/docs/#tag/serviceMap |
| US1 | US East (N. Virginia) | us-east-1 | https://api.sumologic.com/docs/#tag/serviceMap |
| US2 | US West (Oregon) | us-west-2 | https://api.us2.sumologic.com/docs/#tag/serviceMap |
Required role capabilities
To use the APIs in this resource, the user or account executing APIs must have the following role capabilities:
- Security
- Allowlist IP Addresses
Endpoints for API access
Sumo Logic has deployments that are assigned depending on the geographic location and the date an account is created. For API access, you must manually direct your API client to the correct Sumo Logic API URL.
See Sumo Logic Endpoints for the list of the URLs.
An HTTP 301 Moved error suggests that the wrong endpoint was specified.
Errors
The APIs return operation failures with a description and error code, including the following generic errors that apply to all APIs:
| Code | Error | Description |
|---|---|---|
| 301 | moved | The requested resource SHOULD be accessed through returned URI in Location Header. |
| 401 | unauthorized | Credential could not be verified. |
| 403 | forbidden | This operation is not allowed for your account type. |
| 404 | notfound | Requested resource could not be found. |
| 405 | method.unsupported | Unsupported method for URL. |
| 415 | contenttype.invalid | Invalid content type. |
| 429 | rate.limit.exceeded | The API request rate is higher than 4 request per second. |
| 500 | internal.error | Internal server error. |
| 503 | service.unavailable | Service is currently unavailable. |