load-balancer

Get load balancer backend

Returns service backend details by given {service-uuid} and {backend-name}.

get/1.3/load-balancer/{service-uuid}/backends/{backend-name}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/load-balancer/{service-uuid}/backends/{backend-name}
  • Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The UUID of the service.

Example:01234567-89ab-cdef-0123-456789abcdef

The unique identifier for the service.

backend-namestring required

The name of the backend.

Example:backend-infra

The unique identifier for the backend.

Response

Created

namestring required

Human-readable name of the backend

resolverstring nullable

Optional outbound DNS resolver reference used by this backend. Null when not set.

created_atstring date-time required

Timestamp when the backend was created (RFC 3339 format).

updated_atstring date-time required

Timestamp when the backend was last updated (RFC 3339 format).

Example response

{
  "name": "api-backend",
  "members": [
    {
      "name": "member-1",
      "ip": "192.168.1.10",
      "port": 8080,
      "weight": 10,
      "max_sessions": 100,
      "type": "static",
      "enabled": true,
      "backup": false,
      "created_at": "2025-11-05T12:30:00.000Z",
      "updated_at": "2025-11-05T13:45:00.000Z"
    }
  ],
  "tls_configs": [
    {
      "name": "backend-tls-config",
      "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001",
      "created_at": "2025-11-06T10:15:00.000Z",
      "updated_at": "2025-11-06T11:00:00.000Z"
    }
  ],
  "resolver": "resolver-default",
  "properties": {
    "backend_id": 401,
    "timeout_server": 5000,
    "timeout_tunnel": 15000,
    "health_check_type": "http",
    "health_check_interval": 10,
    "health_check_fall": 3,
    "health_check_rise": 2,
    "health_check_url": "/status",
    "health_check_expected_status": 200,
    "health_check_tls_verify": true,
    "health_check_on_down": "shutdown-sessions",
    "tls_enabled": true,
    "tls_verify": true,
    "tls_use_system_ca": false,
    "http2_enabled": true
  },
  "created_at": "2025-11-06T09:00:00.000Z",
  "updated_at": "2025-11-06T11:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.