Kong · Schema

IntegrationInstanceRef

Short-hand descriptor of an integration instance.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The integration instance ID.
name	string	The machine name of the integration instance that uniquely identifies it within the catalog.
display_name	string	The display name of the integration instance.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IntegrationInstanceRef",
  "title": "IntegrationInstanceRef",
  "description": "Short-hand descriptor of an integration instance.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The integration instance ID.",
      "type": "string",
      "format": "uuid",
      "example": "772b9caf-ddbc-4f4f-8aa4-8dfbbe420351"
    },
    "name": {
      "description": "The machine name of the integration instance that uniquely identifies it within the catalog.\n",
      "type": "string",
      "example": "aws-lambda-prod",
      "pattern": "^[0-9a-z.-]+$"
    },
    "display_name": {
      "description": "The display name of the integration instance.",
      "type": "string",
      "example": "AWS (prod)"
    }
  },
  "required": [
    "id",
    "name",
    "display_name"
  ]
}