How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sumo Logic dashboardManagement API

Dashboard (New) management API.Dashboard (New) allows you to analyze metric and log data on the same dashboard, in a seamless view. This gives you control over the visual display of metric and log data. Dashboard (New) streamlines dashboard configurations and on-the-fly analytic visualizations with its new templating features. For more information, see [Dashboard (New)](https://help.sumologic.com/?cid=5500).

Sumo Logic dashboardManagement API is one of 61 APIs that Sumo Logic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 17 operations across 11 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 10 base URLs: https://api.au.sumologic.com/api/, https://api.ca.sumologic.com/api/, https://api.de.sumologic.com/api/, https://api.eu.sumologic.com/api/, https://api.fed.sumologic.com/api/, https://api.jp.sumologic.com/api/, https://api.kr.sumologic.com/api/, https://api.in.sumologic.com/api/, https://api.sumologic.com/api/, https://api.us2.sumologic.com/api/.

17 operations 11 paths 34 schemas 2 DELETE8 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.sumologic.com/api
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Sumo Logic dashboardManagement API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

dashboardManagement 17

Dashboard (New) management API. Dashboard (New) allows you to analyze metric and log data on the same dashboard, in a seamless view. This gives you control over the visual display…

GET
/v2/dashboards
List All Dashboards.
listDashboards 3 params → 200default
POST
/v2/dashboards
Create A New Dashboard.
createDashboard body → 200default
GET
/v2/dashboards/{id}
Get A Dashboard.
getDashboard 1 param → 200default
PUT
/v2/dashboards/{id}
Update A Dashboard.
updateDashboard 1 param body → 200default
DELETE
/v2/dashboards/{id}
Delete A Dashboard.
deleteDashboard 1 param → 204default
POST
/v2/dashboards/reportJobs
Start A Report Job
generateDashboardReport body → 200default
GET
/v2/dashboards/reportJobs/{jobId}/status
Get Report Generation Job Status
getAsyncReportGenerationStatus 1 param → 200default
GET
/v2/dashboards/reportJobs/{jobId}/result
Get Report Generation Job Result
getAsyncReportGenerationResult 1 param → 200default
POST
/v2/dashboards/migrate
Migrate Legacy Dashboards To Dashboards(New)
migrateReportToDashboard body → 200default
POST
/v2/dashboards/migrate/preview
Preview Of Migrating Legacy Dashboards To Dashboards(New)
previewMigrateReportToDashboard body → 200default
GET
/v2/dashboards/migrate/{jobId}/status
Get Dashboard Migration Status.
getDashboardMigrationStatus 1 param → 200default
GET
/v2/dashboards/migrate/{jobId}/result
Get Dashboard Migration Result.
getDashboardMigrationResult 1 param → 200default
GET
/v1/dashboards/reportSchedules
List All Dashboard Report Schedules.
listReportSchedules 3 params → 200default
POST
/v1/dashboards/reportSchedules
Schedule Dashboard Report
createScheduleReport body → 200default
GET
/v1/dashboards/reportSchedules/{scheduleId}
Get Dashboard Report Schedule.
getReportSchedule 1 param → 200default
PUT
/v1/dashboards/reportSchedules/{scheduleId}
Update Dashboard Report Schedule.
updateReportSchedule 1 param body → 200default
DELETE
/v1/dashboards/reportSchedules/{scheduleId}
Delete Dashboard Report Schedule.
deleteReportSchedule 1 param → 204default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are DashboardRequest (15 properties), ReportScheduleRequest (9 properties), Variable (9 properties), VariableValuesData (7 properties). Each schema is shown below with its type and property counts.

VariableValuesData
object
Variable values, status, type and errors for the variable values search.
7 properties 1 required
LayoutStructure
object
2 properties 2 required
Action
object
The base class of all connection types.
1 property 1 required
Template
object
1 property 1 required
OrgId
string
The unique identifier of an organization. It consists of the deployment ID and the hexadecimal account ID separated by a dash - character.
TopologyLabelValuesList
array
List of values corresponding to a key of a label.
TopologyLabelMap
object
Map of the topology labels. Each label has a key and a list of values. If a value is , it means the label will match content for all values of its key.
1 property 1 required
VariableSourceDefinition
object
1 property 1 required
BeginAsyncJobResponseV2
object
1 property 1 required
Panel
object
6 properties 2 required
ResolvableTimeRange
object
1 property 1 required
PaginatedDashboards
object
2 properties 1 required
ErrorResponse
object
2 properties 2 required
Email
Organizations
object
The organization details to run the dashboard by
1 property
DashboardMigrationStatus
object
3 properties 3 required
ErrorDescription
object
4 properties 2 required
PaginatedReportSchedules
object
2 properties 1 required
ReportScheduleRequest
object
9 properties 5 required
AsyncJobStatus
object
3 properties 1 required
MigratedDashboardInfo
object
2 properties 2 required
ReportAction
object
The base class of all report action types. DirectDownloadReportAction downloads dashboard from browser. New action types may be supported in the future.
1 property 1 required
BeginAsyncJobResponse
object
1 property 1 required
MigrationPreviewResponse
object
Preview of the dashboard migration.
1 property 1 required
GenerateReportRequest
object
4 properties 4 required
Layout
object
2 properties 2 required
Variable
object
9 properties 2 required
ReportSchedule
DashboardMigrationResult
object
5 properties 2 required
Dashboard
VariablesValuesData
object
2 properties 1 required
DashboardMigrationRequest
object
1 property 1 required
DashboardRequest
object
15 properties 2 required
DashboardSearchStatus
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sumo-logic-dashboardmanagement-api-openapi.yml Raw ↑

Other APIs Sumo Logic publishes across the network.

Sumo Logic accessKeyManagement API
Sumo Logic accountManagement API
Sumo Logic appManagement API
Sumo Logic appManagementV2 API
Sumo Logic archiveManagement API
Sumo Logic budgetManagement API
Sumo Logic connectionManagement API
Sumo Logic contentManagement API
Sumo Logic contentPermissions API
Sumo Logic dataDeletionRules API
Sumo Logic dataMaskingManagement API
Sumo Logic dynamicParsingRuleManagement API
Where this information came from

This is an independent, third-party profile of Sumo Logic dashboardManagement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.