Upsert a Target associated with an Upstream in a workspace
Create or Update a Target associated with an Upstream using ID or target in a workspace.
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 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
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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
List all Targets associated with an Upstream
List all Targets associated with an Upstream
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 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
Authentication
Path Parameters
Query Parameters
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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