ServerWorkloadListDTO

Page of Server Workloads

pageint32

Page of entities

perPageint32

Number of entities requested for the current page

orderstringnullable

Ordering criteria used for the current page

statusCodeint32

recordsTotalint32

serverWorkloads object[]nullable

Array [

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

serviceEndpoint objectrequired

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

]

typestringnullable

Type of Server Workload

accessPolicyCountint32

Access Policies associated with this Server Workload

]

ServerWorkloadListDTO

{
  "page": 0,
  "perPage": 0,
  "order": "string",
  "statusCode": 0,
  "recordsTotal": 0,
  "serverWorkloads": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "isActive": true,
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "createdAt": "2024-07-29T15:51:28.071Z",
      "modifiedAt": "2024-07-29T15:51:28.071Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "serviceEndpoint": {
        "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"
          }
        ]
      },
      "type": "string",
      "accessPolicyCount": 0
    }
  ]
}