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

Kong Dashboards API

The Dashboards API from Kong — 2 operation(s) for dashboards.

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

This API exposes 1 JSON Schema definition.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

5 operations 2 paths 41 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Dashboards API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 5

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

Dashboards 5
GET
/v2/dashboards
List dashboards
dashboards-list 4 params → 200401403
POST
/v2/dashboards
Create a new dashboard
dashboards-create body → 201400401403
GET
/v2/dashboards/{dashboardId}
Get a single dashboard
dashboards-get 1 param → 200401403404
PUT
/v2/dashboards/{dashboardId}
Update an existing dashboard
dashboards-update 1 param body → 200400401403404
DELETE
/v2/dashboards/{dashboardId}
Delete an existing dashboard
dashboards-delete 1 param → 204401403404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are DashboardResponse (7 properties), AgenticQuery (6 properties), LLMQuery (6 properties), AdvancedQuery (6 properties). Each schema is shown below with its type and property counts.

BaseError
object
standard error
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
ChartTile
object
A tile that queries data and renders a chart.
3 properties 3 required
LLMQuery
object
A query targeting the LLM usage analytics datasource.
6 properties 1 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
UUID
string
Contains a unique identifier used for this resource.
AdvancedQuery
object
A query targeting the API usage analytics datasource.
6 properties 1 required
UnauthorizedError
NotFoundError
LLMMetrics
array
List of aggregated metrics to collect across the requested time span.
DonutChart
object
A chart that can display one-dimensional data in a hollow, segmented circle. To use this chart, ensure that the query includes only one dimension (not time).
2 properties 1 required
LabelsFieldFilter
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
AgenticQuery
object
A query targeting the agentic usage analytics datasource.
6 properties 1 required
Tile
BarChart
object
A chart that can display non-timeseries data as bars. This type of chart supports up to 2 dimensions (not time). To render a bar chart of timeseries data, use…
3 properties 1 required
Dashboard
object
A JSON object describing a dashboard. A dashboard is an array of tiles. All tiles are of type 'chart', which query data and render a chart displaying that data…
2 properties 1 required
AgenticMetrics
array
List of aggregated metrics to collect across the requested time span.
TimeRange
The time range to query.
DashboardResponse
object
7 properties 2 required
DashboardUpdateRequest
object
3 properties 2 required
AdvancedMetrics
array
List of aggregated metrics to collect across the requested time span. If no metrics are specified, requestcount will be computed by default.
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
Chart
The type of chart to render.
AllFilterItems
object
3 properties 2 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
ChoroplethMapChart
object
A chart that displays data on a world map. Each region on the map is colored based on the metric value. This chart works only with the apiusage datasource and…
2 properties 1 required
DashboardFilterParameters
object
5 properties
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
MetricsRelativeTimeRangeDtoV2
object
A duration representing a relative-to-now span of time. Generally the start time is floored to the requested granularity. Eg 7d from now, with 1day granularity…
3 properties 2 required
AdvancedFilters
array
A list of filters to apply to the query.
ForbiddenError
TimeseriesChart
object
A chart that can render timeseries data -- data from a query that has time as a dimension -- as lines or bars. This type of chart can support: - One or more me…
3 properties 1 required
SortQuery
string
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provi…
Granularity
string
Force time grouping into buckets of the specified duration. Only has an effect if "time" is in the "dimensions" list. The granularity of the result may be coar…
LLMFilters
array
A list of filters to apply to the query.
SingleValueChart
object
A chart that can render a single number. This chart works with a single metric and no dimensions.
3 properties 1 required
MetricsAbsoluteTimeRangeDtoV2
object
A duration representing an exact start and end time.
4 properties 1 required
AgenticFilters
array
A list of filters to apply to the query.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-dashboards-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

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