Upsert a Service
Create or Update Service using ID or name.
Path Parameters
ID of the Service to lookup
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the Service
Service
Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its protocol, host, port and path individually. Services are associated to Routes (a Service can have many Routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a Route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.
Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
Certificate to be used as client certificate while TLS handshaking to the upstream server.
Show Child Parameters
The timeout in milliseconds for establishing a connection to the upstream server.
Default:60000
>= 1<= 2147483646
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
Default:true
The host of the upstream server. Note that the host value is case sensitive.
A string representing a UUID (universally unique identifier).
>= 1 characters
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The Service name.
The path to be used in requests to the upstream server.
The upstream server port.
Default:80
>= 0<= 65535
The protocol used to communicate with the upstream.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
Default:http
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
Default:60000
>= 1<= 2147483646
The number of retries to execute upon failure to proxy.
Default:5
>= 0<= 32767
A string representing a tag.
Additional Subject Alternative Names that can be matched on Upstream server’s TLS certificate (in addition to host).
Show Child Parameters
Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected.
>= 0<= 64
Unix epoch when the resource was last updated.
Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.
The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
Default:60000
>= 1<= 2147483646
Response
application/json
Response
Successfully upserted Service
Service
Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its protocol, host, port and path individually. Services are associated to Routes (a Service can have many Routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a Route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.
Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
Certificate to be used as client certificate while TLS handshaking to the upstream server.
Show Child Parameters
The timeout in milliseconds for establishing a connection to the upstream server.
Default:60000
>= 1<= 2147483646
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
Default:true
The host of the upstream server. Note that the host value is case sensitive.
A string representing a UUID (universally unique identifier).
>= 1 characters
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The Service name.
The path to be used in requests to the upstream server.
The upstream server port.
Default:80
>= 0<= 65535
The protocol used to communicate with the upstream.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
Default:http
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
Default:60000
>= 1<= 2147483646
The number of retries to execute upon failure to proxy.
Default:5
>= 0<= 32767
A string representing a tag.
Additional Subject Alternative Names that can be matched on Upstream server’s TLS certificate (in addition to host).
Show Child Parameters
Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected.
>= 0<= 64
Unix epoch when the resource was last updated.
Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.
The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
Default:60000
>= 1<= 2147483646
Authentication
Path Parameters
Body
Targets
A target is an IP address or hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly.
To disable a target, post a new one with weight=0, or use the DELETE method to accomplish the same.
List all targets for a control plane
Returns a collection of all targets for a control plane.
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of targets.
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with weight=0; alternatively, use the DELETE convenience method to accomplish the same. The current target object definition is the one with the latest created_at.
Example:{"id":"089292a7-ba3d-4d88-acf0-97b4b2e2621a","target":"203.0.113.42","upstream":{"id":"5f1d7e76-2fed-4806-a6af-869984f025cb"},"weight":100}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
List all targets for a control plane in a workspace
Returns a collection of all targets for a control plane.
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of targets.
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with weight=0; alternatively, use the DELETE convenience method to accomplish the same. The current target object definition is the one with the latest created_at.
Example:{"id":"089292a7-ba3d-4d88-acf0-97b4b2e2621a","target":"203.0.113.42","upstream":{"id":"5f1d7e76-2fed-4806-a6af-869984f025cb"},"weight":100}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
List all Targets associated with an Upstream in a workspace
List all Targets associated with an Upstream in a workspace
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
ID or target of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Targets
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with weight=0; alternatively, use the DELETE convenience method to accomplish the same. The current target object definition is the one with the latest created_at.
Example:{"id":"089292a7-ba3d-4d88-acf0-97b4b2e2621a","target":"203.0.113.42","upstream":{"id":"5f1d7e76-2fed-4806-a6af-869984f025cb"},"weight":100}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page