Kong · Schema

UpdateIntegrationInstance

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
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.
description string Optionally provide a description of the integration instance.
labels object
config object
View JSON Schema on GitHub

JSON Schema

kong-updateintegrationinstance-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateIntegrationInstance",
  "title": "UpdateIntegrationInstance",
  "type": "object",
  "properties": {
    "name": {
      "description": "The machine name of the integration instance that uniquely identifies it within the catalog.\n",
      "type": "string",
      "example": "aws-lambda-prod",
      "maxLength": 120,
      "minLength": 1,
      "pattern": "^[0-9a-z.-]+$"
    },
    "display_name": {
      "description": "The display name of the integration instance.",
      "type": "string",
      "example": "AWS (prod)",
      "maxLength": 120,
      "minLength": 1
    },
    "description": {
      "description": "Optionally provide a description of the integration instance.",
      "type": "string",
      "maxLength": 2048,
      "nullable": true
    },
    "labels": {
      "$ref": "#/components/schemas/LabelsUpdate"
    },
    "config": {
      "$ref": "#/components/schemas/IntegrationInstanceConfig"
    }
  },
  "additionalProperties": false
}