Kong · Schema

Service

A Service entity represents an upstream API or microservice that Kong Gateway forwards requests to.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The unique identifier of the Service.
name	string	An optional human-readable name for the Service.
protocol	string	The protocol used to communicate with the upstream.
host	string	The host of the upstream server.
port	integer	The upstream server port.
path	string	The path to be used in requests to the upstream server.
retries	integer	The number of retries to execute upon failure to proxy.
connect_timeout	integer	The timeout in milliseconds for establishing a connection to the upstream server.
write_timeout	integer	The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
read_timeout	integer	The timeout in milliseconds between two successive read operations for receiving a request from the upstream server.
url	string	Shorthand attribute to set protocol, host, port, and path at once. Write-only convenience field.
tags	array	An optional set of strings for grouping and filtering.
client_certificate	object	Certificate to be used as client certificate while TLS handshaking to the upstream server.
tls_verify	boolean	Whether to enable TLS verification of upstream server certificate.
tls_verify_depth	integer	Maximum depth of chain while verifying upstream server TLS certificate.
ca_certificates	array	Array of CA Certificate object UUIDs used to verify upstream server TLS certificate.
enabled	boolean	Whether the Service is active.
created_at	integer	Unix epoch timestamp of when the entity was created.
updated_at	integer	Unix epoch timestamp of when the entity was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Service",
  "type": "object",
  "description": "A Service entity represents an upstream API or microservice that Kong Gateway forwards requests to.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the Service."
    },
    "name": {
      "type": "string",
      "description": "An optional human-readable name for the Service."
    },
    "protocol": {
      "type": "string",
      "description": "The protocol used to communicate with the upstream."
    },
    "host": {
      "type": "string",
      "description": "The host of the upstream server."
    },
    "port": {
      "type": "integer",
      "description": "The upstream server port."
    },
    "path": {
      "type": "string",
      "description": "The path to be used in requests to the upstream server."
    },
    "retries": {
      "type": "integer",
      "description": "The number of retries to execute upon failure to proxy."
    },
    "connect_timeout": {
      "type": "integer",
      "description": "The timeout in milliseconds for establishing a connection to the upstream server."
    },
    "write_timeout": {
      "type": "integer",
      "description": "The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server."
    },
    "read_timeout": {
      "type": "integer",
      "description": "The timeout in milliseconds between two successive read operations for receiving a request from the upstream server."
    },
    "url": {
      "type": "string",
      "description": "Shorthand attribute to set protocol, host, port, and path at once. Write-only convenience field."
    },
    "tags": {
      "type": "array",
      "description": "An optional set of strings for grouping and filtering."
    },
    "client_certificate": {
      "type": "object",
      "description": "Certificate to be used as client certificate while TLS handshaking to the upstream server."
    },
    "tls_verify": {
      "type": "boolean",
      "description": "Whether to enable TLS verification of upstream server certificate."
    },
    "tls_verify_depth": {
      "type": "integer",
      "description": "Maximum depth of chain while verifying upstream server TLS certificate."
    },
    "ca_certificates": {
      "type": "array",
      "description": "Array of CA Certificate object UUIDs used to verify upstream server TLS certificate."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the Service is active."
    },
    "created_at": {
      "type": "integer",
      "description": "Unix epoch timestamp of when the entity was created."
    },
    "updated_at": {
      "type": "integer",
      "description": "Unix epoch timestamp of when the entity was last updated."
    }
  }
}