Apigee · Schema

TargetServer

Configuration for a backend target server.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationsMicroservicesMCPModel Context ProtocolMonetization

Properties

Name	Type	Description
name	string	Required. Name of the target server.
host	string	Required. Hostname or IP address of the backend service.
port	integer	Required. Port number of the backend service.
isEnabled	boolean	Whether the target server is enabled.
protocol	string	Protocol used to communicate with the target.
sSLInfo	object
description	string	Optional description of the target server.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TargetServer",
  "title": "TargetServer",
  "type": "object",
  "description": "Configuration for a backend target server.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Required. Name of the target server."
    },
    "host": {
      "type": "string",
      "description": "Required. Hostname or IP address of the backend service."
    },
    "port": {
      "type": "integer",
      "format": "int32",
      "description": "Required. Port number of the backend service."
    },
    "isEnabled": {
      "type": "boolean",
      "description": "Whether the target server is enabled."
    },
    "protocol": {
      "type": "string",
      "description": "Protocol used to communicate with the target.",
      "enum": [
        "HTTP",
        "HTTP2",
        "GRPC_TARGET",
        "GRPC",
        "EXTERNAL_CALLOUT"
      ]
    },
    "sSLInfo": {
      "$ref": "#/components/schemas/TlsInfo"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the target server."
    }
  },
  "required": [
    "name",
    "host",
    "port"
  ]
}