Create a new Target associated with an Upstream
Create a new Target associated with an Upstream
Path Parameters
ID or target of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
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 new Target for creation
TargetWithoutParents
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.
Default:100
>= 0<= 65535
Response
201 application/json
Response
Successfully created Target
Target
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.
Default:100
>= 0<= 65535
Authentication
Path Parameters
Body
Delete a a Target associated with an Upstream
Delete a a Target associated with an Upstream using ID or target.
Path Parameters
ID or target of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
ID of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted Target or the resource didn’t exist
Authentication
Path Parameters
Get a Target associated with an Upstream
Get a Target associated with an Upstream using ID or target.
Path Parameters
ID or target of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
ID of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched Target
Target
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.
Default:100
>= 0<= 65535
Authentication
Path Parameters
Upsert a Target associated with an Upstream
Create or Update a Target associated with an Upstream using ID or target.
Path Parameters
ID or target of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
ID of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
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 Target
TargetWithoutParents
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.
Default:100
>= 0<= 65535
Response
200 application/json
Response
Successfully upserted Target
Target
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.
Default:100
>= 0<= 65535
Authentication
Path Parameters
Body
Upstreams
The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets).
An upstream also includes a health checker, which can enable and disable targets based on their ability or inability to serve requests.
The configuration for the health checker is stored in the upstream object, and applies to all of its targets.