AccessAudit4

AccessRole4

AccessRoleBinding4

Add-Ons4

AI Gateway Agents4

AI Gateway Auth Strategies4

AI Gateway CA Certificates4

AI Gateway Certificates4

AI Gateway Config Stores8

AI Gateway Consumer Groups6

AI Gateway Consumers7

AI Gateway DataPlane Certificates3

AI Gateway Identity Providers4

AI Gateway MCP Servers4

AI Gateway Model Providers4

AI Gateway Models4

AI Gateway Policies4

AI Gateway SNIs4

AI Gateway Vaults4

AI Gateways4

API4

API Documentation4

API Implementation3

API Publication3

API Specification4

API Version4

Application Registrations4

Applications4

Assets4

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Server Trusted IdPs3

Dashboards4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Vaults4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

HostnameGenerator4

Kong Identity Directories4

Mesh9

MeshAccessLog4

MeshCircuitBreaker4

MeshExternalService4

MeshFaultInjection4

MeshGateway4

MeshGlobalRateLimit4

MeshHealthCheck4

MeshHTTPRoute4

MeshIdentity4

MeshLoadBalancingStrategy4

MeshMetric4

MeshMultiZoneService4

MeshOPA4

MeshOpenTelemetryBackend4

MeshPassthrough4

MeshProxyPatch4

MeshRateLimit4

MeshRetry4

MeshService4

MeshTCPRoute4

MeshTimeout4

MeshTLS4

MeshTrace4

MeshTrafficPermission4

MeshTrust4

MeshZoneAddress4

Pages4

Personal Access Tokens2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Team Roles2

Portal Teams4

Portals5

Portals IP Allow List4

Secret4

Snippets4

Workload4

ZoneEgress4

ZoneIngress4

Dashboards

Update an existing dashboard

Changed on Aug 18, 2026

Update an existing dashboard, replacing its definition with the provided one.

put/v2/dashboards/{dashboardId}

Request

Base URL: https://global.api.konghq.com
URL: https://global.api.konghq.com/v2/dashboards/{dashboardId}
Auth: one of:
- HTTP bearer
- HTTP bearer
- HTTP bearer
- HTTP bearer

Request body

namestring required

The dashboard name, which is displayed at the top of the dashboard and in lists. It does not need to be unique.

labelsLabels

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, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Example request

{
  "definition": {
    "tiles": [
      {
        "layout": {
          "position": {
            "col": 3,
            "row": 0
          },
          "size": {
            "cols": 3,
            "rows": 1
          }
        },
        "definition": {
          "query": {
            "datasource": "api_usage",
            "time_range": {
              "type": "relative",
              "time_range": "24h",
              "tz": "EST"
            },
            "dimensions": [
              "time",
              "gateway_service"
            ],
            "filters": [
              {
                "operator": "in",
                "field": "control_plane",
                "value": [
                  "d5ac5d88-efed-4e10-9dfe-0b0a6646c219"
                ]
              }
            ],
            "granularity": "hourly",
            "metrics": [
              "request_count",
              "response_latency_p99"
            ]
          }
        }
      }
    ],
    "preset_filters": [
      {
        "operator": "in",
        "field": "control_plane",
        "value": [
          "00000000-0000-0000-0000-000000000000"
        ]
      },
      {
        "operator": "in",
        "field": "ai_request_model",
        "value": [
          "request_model1"
        ]
      }
    ]
  },
  "labels": {
    "env": "test"
  }
}

Response

The created dashboard, including generated fields.

namestring required

The dashboard name, which is displayed at the top of the dashboard and in lists. It does not need to be unique.

labelsLabels

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, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

idstring uuid

Contains a unique identifier used for this resource.

created_bystring uuid

Contains a unique identifier used for this resource.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "definition": {
    "tiles": [
      {
        "layout": {
          "position": {
            "col": 3,
            "row": 0
          },
          "size": {
            "cols": 3,
            "rows": 1
          }
        },
        "definition": {
          "query": {
            "datasource": "api_usage",
            "time_range": {
              "type": "relative",
              "time_range": "24h",
              "tz": "EST"
            },
            "dimensions": [
              "time",
              "gateway_service"
            ],
            "filters": [
              {
                "operator": "in",
                "field": "control_plane",
                "value": [
                  "d5ac5d88-efed-4e10-9dfe-0b0a6646c219"
                ]
              }
            ],
            "granularity": "hourly",
            "metrics": [
              "request_count",
              "response_latency_p99"
            ]
          }
        }
      }
    ],
    "preset_filters": [
      {
        "operator": "in",
        "field": "control_plane",
        "value": [
          "00000000-0000-0000-0000-000000000000"
        ]
      },
      {
        "operator": "in",
        "field": "ai_request_model",
        "value": [
          "request_model1"
        ]
      }
    ]
  },
  "labels": {
    "env": "test"
  },
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_by": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Aug 18, 2026658ffb748f95 Revision changes
- breaking
  the /////// request property type changed from object to no type
- breaking
  added to the /////// response property oneOf list for the response status
- breaking
  the /////// response's property type changed from object to no type for status
- breaking
  removed the required property //////// from the response with the status
- breaking
  removed the required property //////// from the response with the status
- warning
  removed the request property ////////
- warning
  removed the request property ////////
- warning
  added the new cache_status enum value to the /// response property for the response status
- warning
  added the new data_plane_group enum value to the /// response property for the response status
- warning
  added the new env enum value to the /// response property for the response status
- warning
  added the new hostname enum value to the /// response property for the response status
- warning
  added the new managed_cache enum value to the /// response property for the response status
- warning
  added the new network enum value to the /// response property for the response status
- warning
  added the new principal enum value to the /// response property for the response status
- warning
  added the new provider enum value to the /// response property for the response status
- warning
  added the new provider_region enum value to the /// response property for the response status
- warning
  added the new region enum value to the /// response property for the response status
- warning
  added the new team enum value to the /// response property for the response status
- info
  added the new cache_status enum value to the request property ///
- info
  added the new data_plane_group enum value to the request property ///
- info
  added the new env enum value to the request property ///
- info
  added the new hostname enum value to the request property ///
- info
  added the new managed_cache enum value to the request property ///
- info
  added the new network enum value to the request property ///
- info
  added the new principal enum value to the request property ///
- info
  added the new provider enum value to the request property ///
- info
  added the new provider_region enum value to the request property ///
- info
  added the new region enum value to the request property ///
- info
  added the new team enum value to the request property ///
- info
  added to the /////// request property oneOf list
Jun 11, 2026be4c4e09af62 Revision changes
- breaking
  added the new required request property ///////////////
- breaking
  added the new required request property ///////////////
- breaking
  removed the enum value mcp_response_body_size_sum of the request property //////////////
- breaking
  removed from the ////////////// request property oneOf list
- breaking
  the ////////////// request property type changed from no type to object
- breaking
  added to the //////// response property oneOf list for the response status
- breaking
  the ////////////// response's property type changed from no type to object for status
- warning
  added the new a2a_context_id enum value to the /// response property for the response status
- warning
  added the new a2a_error enum value to the /// response property for the response status
- warning
  added the new a2a_method enum value to the /// response property for the response status
- warning
  added the new a2a_task_id enum value to the /// response property for the response status
- warning
  added the new kong_internal_latency_average enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_average enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_p50 enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_p50 enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_p95 enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_p95 enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_p99 enum value to the ////////////// response property for the response status
- warning
  added the new kong_internal_latency_p99 enum value to the ////////////// response property for the response status
- warning
  added the new mcp_error enum value to the /// response property for the response status
- warning
  added the new mcp_method enum value to the /// response property for the response status
- warning
  added the new mcp_response_size_sum enum value to the ////////////// response property for the response status
- warning
  added the new mcp_session_id enum value to the /// response property for the response status
- warning
  added the new mcp_tool_name enum value to the /// response property for the response status
- warning
  added the new realm enum value to the ////////////// response property for the response status
- info
  added the new optional request property ///////////////
- info
  added platform_usage discriminator mapping keys to the //////// request property
- info
  removed discriminator from ////////////// request property
- info
  added the new a2a_context_id enum value to the request property ///
- info
  added the new a2a_error enum value to the request property ///
- info
  added the new a2a_method enum value to the request property ///
- info
  added the new a2a_task_id enum value to the request property ///
- info
  added the new kong_internal_latency_average enum value to the request property //////////////
- info
  added the new kong_internal_latency_average enum value to the request property //////////////
- info
  added the new kong_internal_latency_p50 enum value to the request property //////////////
- info
  added the new kong_internal_latency_p50 enum value to the request property //////////////
- info
  added the new kong_internal_latency_p95 enum value to the request property //////////////
- info
  added the new kong_internal_latency_p95 enum value to the request property //////////////
- info
  added the new kong_internal_latency_p99 enum value to the request property //////////////
- info
  added the new kong_internal_latency_p99 enum value to the request property //////////////
- info
  added the new mcp_error enum value to the request property ///
- info
  added the new mcp_method enum value to the request property ///
- info
  added the new mcp_response_size_sum enum value to the request property //////////////
- info
  added the new mcp_session_id enum value to the request property ///
- info
  added the new mcp_tool_name enum value to the request property ///
- info
  added the new realm enum value to the request property //////////////
- info
  added to the //////// request property oneOf list
- info
  added the optional property /////////////// to the response with the status
- info
  added platform_usage discriminator mapping keys to the //////// response property for the response status
- info
  removed discriminator from ////////////// response property for the response status
- info
  removed the mcp_response_body_size_sum enum value from the ////////////// response property for the response status
- info
  removed from the ////////////// response property oneOf list for the response status
- info
  added the required property /////////////// to the response with the status
- info
  added the required property /////////////// to the response with the status

Operation history (8 revisions)