Skip to main content

WorkloadServiceEndpointDTO

Service Endpoint for a Server Workload

externalIdstringnullable

External ID of the Service Endpoint

idint32

ID of the Service Endpoint

hoststringrequired

Hostname or IP Address

Possible values: non-empty

appProtocolstringrequired

Application Protocol

Possible values: non-empty

transportProtocolstringrequired

Transport Protocol (e.g. TCP)

Possible values: <= 3 characters

requestedPortint32required

The target port as specified by the Client Workload

Possible values: >= 1 and <= 65535

requestedTlsbooleanrequired

The TLS encryption configuration of the Client Workload

portint32required

The target port to which the Agent/Proxy will communicate

Possible values: >= 1 and <= 65535

tlsbooleanrequired

The TLS encryption configuration which will be used by the Agent/Proxy

workloadServiceAuthentication object

Authentication configuration for a Server Workload

methodstringrequired

Authentication Method

Possible values: non-empty

schemestringrequired

Authentication Scheme

Possible values: non-empty

configstringnullable

Authentication Configuration

tlsVerificationstringrequired

TLS Verification configuration for the Agent/Proxy to Server Workload connection

Possible values: non-empty

httpHeaders object[]nullable

Static HTTP Headers to include for transmission to the Server Workload

  • Array [
  • keystringnullable
    valuestringnullable
  • ]
  • WorkloadServiceEndpointDTO
    {
    "externalId": "string",
    "id": 0,
    "host": "string",
    "appProtocol": "string",
    "transportProtocol": "string",
    "requestedPort": 0,
    "requestedTls": true,
    "port": 0,
    "tls": true,
    "workloadServiceAuthentication": {
    "method": "string",
    "scheme": "string",
    "config": "string"
    },
    "tlsVerification": "string",
    "httpHeaders": [
    {
    "key": "string",
    "value": "string"
    }
    ]
    }