Kong · Schema
Service
A Service entity represents an upstream API or microservice that Kong Gateway forwards requests to.
API GatewayLuaNGINXOpen 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. |