Kong · Schema

ServiceInput

Input schema for creating or updating a Service.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
name	string	An optional human-readable name for the Service.
protocol	string
host	string	The host of the upstream server.
port	integer
path	string
retries	integer
connect_timeout	integer
write_timeout	integer
read_timeout	integer
url	string	Shorthand attribute to set protocol, host, port, and path at once.
tags	array
client_certificate	object
tls_verify	boolean
tls_verify_depth	integer
ca_certificates	array
enabled	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ServiceInput",
  "type": "object",
  "description": "Input schema for creating or updating a Service.",
  "properties": {
    "name": {
      "type": "string",
      "description": "An optional human-readable name for the Service."
    },
    "protocol": {
      "type": "string"
    },
    "host": {
      "type": "string",
      "description": "The host of the upstream server."
    },
    "port": {
      "type": "integer"
    },
    "path": {
      "type": "string"
    },
    "retries": {
      "type": "integer"
    },
    "connect_timeout": {
      "type": "integer"
    },
    "write_timeout": {
      "type": "integer"
    },
    "read_timeout": {
      "type": "integer"
    },
    "url": {
      "type": "string",
      "description": "Shorthand attribute to set protocol, host, port, and path at once."
    },
    "tags": {
      "type": "array"
    },
    "client_certificate": {
      "type": "object"
    },
    "tls_verify": {
      "type": "boolean"
    },
    "tls_verify_depth": {
      "type": "integer"
    },
    "ca_certificates": {
      "type": "array"
    },
    "enabled": {
      "type": "boolean"
    }
  }
}