ACLs7

Add-Ons5

AI Gateway Agents5

AI Gateway Auth Strategies5

AI Gateway CA Certificates5

AI Gateway Certificates5

AI Gateway Config Stores10

AI Gateway Consumer Groups8

AI Gateway Consumers11

AI Gateway Custom Policies5

AI Gateway DataPlane Certificates4

AI Gateway Identity Providers5

AI Gateway MCP Servers5

AI Gateway Model Providers5

AI Gateway Models5

AI Gateway Nodes3

AI Gateway Policies5

AI Gateway SNIs10

AI Gateway Vaults5

AI Gateways6

API6

API Attributes1

API Documentation6

API Image4

API Implementation4

API Operations2

API Package Documentation6

API Package Image4

API Package Operations4

API Package Specification4

API Packages5

API Publication8

API Specification6

API Version5

API-keys7

App Auth Strategies6

Application Registrations8

Applications8

Assets6

Auth Settings17

Authentication1

Basic-auth credentials7

CA Certificates5

Catalog AI Model Implementations4

Catalog AI Model Specs4

Catalog AI Model Versions6

Catalog AI Models6

Catalog Integrations1

Catalog MCP Implementations4

Catalog MCP Versions6

Catalog MCPs6

Catalog Resource Mappings4

Catalog Resource Services1

Catalog Resources3

Catalog Service API Mappings5

Catalog Service Resources1

Catalog Services5

Certificates5

Cloud Gateways Resource Quotas3

Config Store Secrets5

Config Stores5

Consumer Groups9

Consumers9

Context Interface Capability Controls3

Context Interfaces7

Context Source Mappings4

Context Sources5

Control Plane Groups6

Control Plane Mappings5

Control Planes5

Criteria Templates1

Custom Domains5

Custom Plugin Schemas5

CustomPlugins5

Dashboards5

Data-Plane Group Configurations3

DCR Providers6

Degraphql_routes7

DP Certificates5

DP Nodes6

Event Gateway Backend Clusters5

Event Gateway DataPlane Certificates5

Event Gateway Listener Policies9

Event Gateway Listeners5

Event Gateway Nodes4

Event Gateway Schema Registries5

Event Gateway Static Keys4

Event Gateway TLS Trust Bundles5

Event Gateway Virtual Cluster Consume Policies9

Event Gateway Virtual Cluster Policies9

Event Gateway Virtual Cluster Produce Policies9

Event Gateway Virtual Clusters5

Event Gateways6

GraphQL Cost Decorations7

HMAC-auth credentials7

Impersonation Settings2

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances5

Invites1

JWTs7

Keys10

KeySets5

Me2

Mesh6

Metering Events2

Meters6

MTLS-auth credentials7

Networks6

Notifications11

OpenMeter Apps7

OpenMeter Billing Settings14

OpenMeter Currencies5

OpenMeter Customers20

OpenMeter Defaults2

OpenMeter Entitlements18

OpenMeter Features6

OpenMeter LLM Cost5

OpenMeter Notifications5

OpenMeter Product Catalog19

OpenMeter Subscriptions12

OpenMeter Tax5

Pages7

Partial Links1

Partials5

Personal Access Tokens6

Plugins26

Portal Audit Logs6

Portal Auth Settings13

Portal Custom Domains4

Portal Customization3

Portal Developers5

Portal Emails19

Portal Forms5

Portal Integrations3

Portal Team Membership4

Portal Team Roles4

Portal Teams5

Portals5

Portals IP Allow List6

Private DNS5

Provider Accounts2

Resource Availability1

Resource Configurations3

Roles9

Routes10

Schemas2

Scorecards11

Services5

Signaling APIs10

Skills6

Snippets5

SNIs10

System Accounts5

System Accounts - Access Tokens5

System Accounts - Roles4

System Accounts - Team Membership4

Targets6

Team Membership4

Teams5

Transit Gateways5

Upstreams5

Users4

Vaults5

Dashboards

Update an existing dashboard

Changed on Sep 25, 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

Sep 25, 202668d43091b84d Revision changes
- warning
  added the new 403.00 enum value to the response property for the response status
- warning
  added the new 404.00 enum value to the response property for the response status
- warning
  added the new ai_gateway enum value to the /// response property for the response status
- warning
  added the new ai_gateway enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_agent enum value to the /// response property for the response status
- warning
  added the new ai_gateway_agent enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_agent enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_agent enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_agent enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the /// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the /// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_consumer_group enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the /// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_data_plane_node enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_mcp_server enum value to the /// response property for the response status
- warning
  added the new ai_gateway_mcp_server enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_mcp_server enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_mcp_server enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_mcp_server enum value to the /////////////////// response property for the response status
- warning
  added the new ai_gateway_model enum value to the /// response property for the response status
- warning
  added the new ai_gateway_model enum value to the ////////////////// response property for the response status
- warning
  added the new ai_gateway_model enum value to the /////////////////// response property for the response status
- warning
  added the new cache_status enum value to the ////////////////// response property for the response status
- warning
  added the new cache_status enum value to the /////////////////// response property for the response status
- warning
  added the new cached_tokens enum value to the ////////////////// response property for the response status
- warning
  added the new consumer_group enum value to the /// response property for the response status
- warning
  added the new consumer_group enum value to the ////////////////// response property for the response status
- warning
  added the new consumer_group enum value to the /////////////////// response property for the response status
- warning
  added the new consumer_group enum value to the ////////////////// response property for the response status
- warning
  added the new consumer_group enum value to the /////////////////// response property for the response status
- warning
  added the new time_per_token_average enum value to the ////////////////// response property for the response status
- warning
  added the new time_to_first_token_average enum value to the ////////////////// response property for the response status
- warning
  added the new total_tokens_per_minute enum value to the ////////////////// response property for the response status
- info
  added the new ai_gateway enum value to the request property ///
- info
  added the new ai_gateway enum value to the request property //////////////////
- info
  added the new ai_gateway enum value to the request property ///////////////////
- info
  added the new ai_gateway enum value to the request property //////////////////
- info
  added the new ai_gateway enum value to the request property ///////////////////
- info
  added the new ai_gateway enum value to the request property //////////////////
- info
  added the new ai_gateway enum value to the request property ///////////////////
- info
  added the new ai_gateway_agent enum value to the request property ///
- info
  added the new ai_gateway_agent enum value to the request property //////////////////
- info
  added the new ai_gateway_agent enum value to the request property ///////////////////
- info
  added the new ai_gateway_agent enum value to the request property //////////////////
- info
  added the new ai_gateway_agent enum value to the request property ///////////////////
- info
  added the new ai_gateway_consumer enum value to the request property ///
- info
  added the new ai_gateway_consumer enum value to the request property //////////////////
- info
  added the new ai_gateway_consumer enum value to the request property ///////////////////
- info
  added the new ai_gateway_consumer enum value to the request property //////////////////
- info
  added the new ai_gateway_consumer enum value to the request property ///////////////////
- info
  added the new ai_gateway_consumer enum value to the request property //////////////////
- info
  added the new ai_gateway_consumer enum value to the request property ///////////////////
- info
  added the new ai_gateway_consumer_group enum value to the request property ///
- info
  added the new ai_gateway_consumer_group enum value to the request property //////////////////
- info
  added the new ai_gateway_consumer_group enum value to the request property ///////////////////
- info
  added the new ai_gateway_consumer_group enum value to the request property //////////////////
- info
  added the new ai_gateway_consumer_group enum value to the request property ///////////////////
- info
  added the new ai_gateway_consumer_group enum value to the request property //////////////////
- info
  added the new ai_gateway_consumer_group enum value to the request property ///////////////////
- info
  added the new ai_gateway_data_plane_node enum value to the request property ///
- info
  added the new ai_gateway_data_plane_node enum value to the request property //////////////////
- info
  added the new ai_gateway_data_plane_node enum value to the request property ///////////////////
- info
  added the new ai_gateway_data_plane_node enum value to the request property //////////////////
- info
  added the new ai_gateway_data_plane_node enum value to the request property ///////////////////
- info
  added the new ai_gateway_data_plane_node enum value to the request property //////////////////
- info
  added the new ai_gateway_data_plane_node enum value to the request property ///////////////////
- info
  added the new ai_gateway_mcp_server enum value to the request property ///
- info
  added the new ai_gateway_mcp_server enum value to the request property //////////////////
- info
  added the new ai_gateway_mcp_server enum value to the request property ///////////////////
- info
  added the new ai_gateway_mcp_server enum value to the request property //////////////////
- info
  added the new ai_gateway_mcp_server enum value to the request property ///////////////////
- info
  added the new ai_gateway_model enum value to the request property ///
- info
  added the new ai_gateway_model enum value to the request property //////////////////
- info
  added the new ai_gateway_model enum value to the request property ///////////////////
- info
  added the new cache_status enum value to the request property //////////////////
- info
  added the new cache_status enum value to the request property ///////////////////
- info
  added the new cached_tokens enum value to the request property //////////////////
- info
  added the new consumer_group enum value to the request property ///
- info
  added the new consumer_group enum value to the request property //////////////////
- info
  added the new consumer_group enum value to the request property ///////////////////
- info
  added the new consumer_group enum value to the request property //////////////////
- info
  added the new consumer_group enum value to the request property ///////////////////
- info
  added the new time_per_token_average enum value to the request property //////////////////
- info
  added the new time_to_first_token_average enum value to the request property //////////////////
- info
  added the new total_tokens_per_minute enum value to the request property //////////////////
Sep 18, 2026f324fb7610e4 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the 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 (12 revisions)