Kong · Schema

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`.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
created_at	number	Unix epoch when the resource was created.
failover	boolean	Whether to use this target only as backup or not.
id	string	A string representing a UUID (universally unique identifier).
tags	array	An optional set of strings associated with the Target for grouping and filtering.
target	string	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.
updated_at	number	Unix epoch when the resource was last updated.
upstream	object	The unique identifier or the name of the upstream for which to update the target.
weight	integer	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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TargetWithoutParents",
  "title": "TargetWithoutParents",
  "x-speakeasy-entity": "Target",
  "description": "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`.",
  "type": "object",
  "properties": {
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "number",
      "nullable": true
    },
    "failover": {
      "description": "Whether to use this target only as backup or not.",
      "type": "boolean",
      "default": false,
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "nullable": true
    },
    "tags": {
      "description": "An optional set of strings associated with the Target for grouping and filtering.",
      "type": "array",
      "items": {
        "description": "A string representing a tag.",
        "type": "string"
      },
      "nullable": true
    },
    "target": {
      "description": "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.",
      "type": "string",
      "nullable": true
    },
    "updated_at": {
      "description": "Unix epoch when the resource was last updated.",
      "type": "number",
      "nullable": true
    },
    "upstream": {
      "description": "The unique identifier or the name of the upstream for which to update the target.",
      "type": "object",
      "nullable": true,
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "x-foreign": true
    },
    "weight": {
      "description": "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.",
      "type": "integer",
      "default": 100,
      "maximum": 65535,
      "minimum": 0,
      "nullable": true
    }
  },
  "example": {
    "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
    "target": "203.0.113.42",
    "weight": 100
  },
  "additionalProperties": false,
  "required": [
    "target"
  ]
}