Harness

Harness Dashboards API

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

GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /gitops/api/v1/dashboard/counts Count recently created GitOps apps, clusters and repos · Get recently created app, cluster, repo counts #
Ask an LLM
“How many GitOps applications, clusters and repositories were created in the last month?”
“Can I count new GitOps resources within a specific time window?”
Tell an agent
Count GitOps apps, clusters and repos created between {start} and {end}.
Show recently created GitOps resource counts for project {project}.
GET /gitops/api/v1/dashboard/overview Get the GitOps dashboard overview · Get dashboard overview #
Ask an LLM
“What are the key health and sync metrics on the GitOps dashboard?”
“Can I scope the GitOps overview to a single agent?”
Tell an agent
Show the GitOps dashboard overview for project {project}.
Get the GitOps overview metrics for agent {agent}.
GET /dashboard/api/dashboards/{dashboard_id}/download Download data from all tiles in a dashboard · Download data within a Dashboard #
Ask an LLM
“How do I export the data behind every tile on a custom dashboard?”
“Which file types can I download dashboard tile data in?”
Tell an agent
Download all tile data from dashboard {dashboard} as {file_type}.
Export dashboard {dashboard}'s tile data as {file_type} with filters {filters}.
GET /dashboard/dashboards/{dashboard_id}/elements List the elements of a dashboard · Get dashboard elements #
Ask an LLM
“Which tiles or elements make up a given dashboard?”
“How do I find a dashboard element ID so I can download just that tile?”
Tell an agent
List the elements on dashboard {dashboard}.
Show me every tile ID in dashboard {dashboard}.
GET /dashboard/dashboards/{dashboard_id}/filters List the filters on a dashboard · Get dashboard filters #
Ask an LLM
“What filters are defined on this dashboard and what are their defaults?”
“How do I find a dashboard filter's ID before changing it?”
Tell an agent
List the filters defined on dashboard {dashboard}.
Show the filter IDs and defaults for dashboard {dashboard}.
POST /dashboard/clone Clone a dashboard · Clone dashboard #
Ask an LLM
“Can I copy an existing dashboard to use as a starting point for my own?”
“How do I duplicate a dashboard into a different folder with a new name?”
Tell an agent
Clone dashboard {dashboard}.
Copy dashboard {dashboard} into folder {folder} as {name}.
GET /dashboard/dashboards/{dashboard_id} Get a dashboard's details · Get dashboard #
Ask an LLM
“What are the name, folder and tags of a particular dashboard?”
“Can I look up all the details of one dashboard by its ID?”
Tell an agent
Get the details of dashboard {dashboard}.
Show me dashboard {dashboard}'s name, folder and tags.
PATCH /dashboard/ Rename or move a dashboard · Update dashboard #
Ask an LLM
“How do I rename a dashboard or move it to another folder?”
“Can I change a dashboard's description and tags after creating it?”
Tell an agent
Rename dashboard {dashboard} to {name} in folder {folder}.
Move dashboard {dashboard} to folder {folder}, keeping the name {name}.
DELETE /dashboard/remove Delete a dashboard · Delete dashboard #
Ask an LLM
“How do I delete a single dashboard I no longer need?”
“Do I need the folder ID to remove a dashboard?”
Tell an agent destructive · confirm first
Delete dashboard {dashboard} from folder {folder}.
Remove the dashboard {dashboard} stored in folder {folder}.
PATCH /dashboard/dashboards/{dashboard_id}/filters/{filter_id} Update a filter on a dashboard · Update dashboard filter #
Ask an LLM
“How do I change the default value of a dashboard filter?”
“Can I rename a dashboard filter or change its title?”
Tell an agent
Set filter {filter} on dashboard {dashboard} to default {value}.
Retitle filter {filter} on dashboard {dashboard} as {title}.
GET /dashboard/download/dashboards/{dashboard_id}/csv Download a dashboard as CSV · Download a Dashboard CSV #
Ask an LLM
“Can I export a whole dashboard to a CSV file?”
“How do I get a CSV of a dashboard with expanded tables and visualization settings applied?”
Tell an agent
Download dashboard {dashboard} as a CSV.
Export dashboard {dashboard} to CSV with filters {filters}.
GET /dashboard/download/dashboards/{dashboard_id}/pdf Download a dashboard as PDF · Download a Dashboard PDF #
Ask an LLM
“How do I save a dashboard as a PDF to share with leadership?”
“Can I choose landscape orientation and paper size for a dashboard PDF?”
Tell an agent
Download dashboard {dashboard} as a PDF.
Export dashboard {dashboard} to a landscape PDF on {paper} paper.
POST /dashboard/schedules/run_once Email a dashboard delivery once · Runs a schedule delivery once that is then immediately sent via email to… #
Ask an LLM
“Can I send a dashboard to people by email right now instead of waiting for the schedule?”
“How do I trigger a one-off dashboard delivery with a custom message?”
Tell an agent
Email dashboard {dashboard} as {file_type} to {emails} once, titled {name}.
Send a one-time {file_type} of dashboard {dashboard} named {name} to {emails} with message {message}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://artifacts.apis.io/harness/authentication/harness-authentication.yml
📖
RateLimits
https://artifacts.apis.io/harness/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/harness/openapi/harness-dashboards-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/harness/json-schema/harness-v1-dashboard-overview-schema.json
📊
JSONSchema
https://artifacts.apis.io/harness/json-schema/harness-schedule-report-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/harness/json-schema/harness-v1-recently-created-overview-schema.json
📊
JSONSchema
https://artifacts.apis.io/harness/json-schema/harness-update-dashboard-filter-request-schema.json

Other Resources

🔗
OAuthScopes
https://artifacts.apis.io/harness/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://artifacts.apis.io/harness/errors/harness-error-codes.yml
🔗
Conventions
https://artifacts.apis.io/harness/conventions/harness-conventions.yml
🔗
Idempotency
https://artifacts.apis.io/harness/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-dashboards-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-dashboards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Dashboards API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/harness/openapi/harness-dashboards-api-openapi.yml