Catalog MCPs

Replace MCP

Changed on

Replaces an MCP.

put/v1/mcp-servers/{mcpId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/mcp-servers/{mcpId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

The machine name of the MCP that uniquely identifies it within the catalog.

display_namestring required

The display name of the MCP.

descriptionstring nullable

Optionally provide a description of the MCP.

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

{
  "name": "my-mcp",
  "display_name": "My MCP",
  "description": "Customer support triage model",
  "labels": {
    "env": "test"
  }
}

Response

Response schema for MCPs.

idstring uuid required

The unique identifier of the MCP.

namestring required

The machine name of the MCP that uniquely identifies it within the catalog.

display_namestring required

The display name of the MCP.

descriptionstring nullable required

A description of the MCP.

labelsLabels required

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 "_".

managed_byManagedBy required

Stores information about what manages this entity, such as the tool or system responsible for its lifecycle (for example, terraform).

Keys must be 1–63 characters long and start with an alphanumeric character.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "7703e2f2-f9c0-47e3-9146-5fa50486b871",
  "name": "my-mcp",
  "display_name": "My MCP",
  "description": "Description of MCP.",
  "labels": {
    "env": "test"
  },
  "managed_by": {
    "owner": "terraform"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 59663dd13a10Revision changes
    • info

      endpoint added