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

Harness Dashboards API

The Dashboards API from Harness — 13 operation(s) for dashboards.

Harness Dashboards API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 13 operations across 13 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

13 operations 13 paths 33 schemas 1 DELETE8 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Dashboards API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboards 13
GET
/gitops/api/v1/dashboard/counts
Get recently created app, cluster, repo counts
DashboardService_RecentlyCreatedCounts 5 params → 200default
GET
/gitops/api/v1/dashboard/overview
Get dashboard overview
DashboardService_GetDashboardOverview 5 params → 200default
GET
/dashboard/api/dashboards/{dashboard_id}/download
Download data within a Dashboard
get_dashboard_data 3 params → 200400404default
GET
/dashboard/dashboards/{dashboard_id}/elements
Get dashboard elements
get_dashboard_elements 2 params → 200404default
GET
/dashboard/dashboards/{dashboard_id}/filters
Get dashboard filters
get_dashboard_filters 2 params → 200404default
POST
/dashboard/clone
Clone dashboard
clone_dashboard 1 param body → 200default
GET
/dashboard/dashboards/{dashboard_id}
Get dashboard
get_dashboard 2 params → 200default
PATCH
/dashboard/
Update dashboard
update_dashboard 1 param body → 200
DELETE
/dashboard/remove
Delete dashboard
delete_dashboard 2 params body → 200
PATCH
/dashboard/dashboards/{dashboard_id}/filters/{filter_id}
Update dashboard filter
update_dashboard_filter 2 params body → 200400403404default
GET
/dashboard/download/dashboards/{dashboard_id}/csv
Download a Dashboard CSV
get_dashboard_download_csv 5 params → 200400403404504default
GET
/dashboard/download/dashboards/{dashboard_id}/pdf
Download a Dashboard PDF
get_dashboard_download_pdf 7 params → 200400403404504default
POST
/dashboard/schedules/run_once
Runs a schedule delivery once that is then immediately sent via email to…
schedules_run_once 1 param body → 200400404default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Dashboard (12 properties), DashboardFilter (9 properties), v1DashboardOverview (8 properties), ScheduleReportRequestBody (6 properties). Each schema is shown below with its type and property counts.

gatewayruntimeError
object
4 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
v1SyncStatusCounts
object
3 properties
v1ApplicationStatusCounts
object
3 properties
v1HealthStatusCounts
object
6 properties
v1DashboardOverview
object
8 properties
v1RecentlyCreatedOverview
object
4 properties
v1RecentlyCreatedCount
object
2 properties
ClonedDashboard
object
4 properties 4 required
GetDashboardFilterResponse
object
1 property 1 required
ScheduleReportResponseBody
object
1 property 1 required
DashboardsErrorResponse
object
4 properties 3 required
DashboardFilter
object
9 properties 6 required
GetDashboardResponse
object
1 property 1 required
DownloadCsvDashboardResponse
object
1 property
UpdateDashboardResponseResource
object
4 properties 4 required
CloneDashboardRequestBody
object
4 properties 1 required
DeleteDashboardResponseResource
object
1 property 1 required
GetDashboardElementsResponse
object
1 property 1 required
ScheduleReportResponse
object
1 property 1 required
DashboardElements
object
5 properties 3 required
DownloadPdfDashboardResponse
object
1 property
DashboardDownloadResponse
object
1 property
DashboardFolder
object
4 properties 4 required
DeleteDashboardRequest
object
1 property 1 required
DeleteDashboardResponse
object
1 property 1 required
CreateDashboardRequest
object
4 properties 2 required
UpdateDashboardResponse
object
1 property 1 required
Dashboard
object
12 properties 12 required
GetDashboardFiltersResponse
object
1 property 1 required
ClonedDashboardResponse
object
1 property 1 required
ScheduleReportRequestBody
object
6 properties 4 required
UpdateDashboardFilterRequest
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-dashboards-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Dashboards 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.