load-balancer

List load balancer frontends

Returns a list of available service frontends by given {service-uuid}.

get/1.3/load-balancer/{service-uuid}/frontends

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/load-balancer/{service-uuid}/frontends
  • 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.

Response

Created

namestring required

Human-readable name assigned to the frontend.

portinteger required

Port number on which the frontend listens for incoming connections.

mode'http' | 'tcp' required

Operating mode defining the protocol layer at which the frontend operates.

default_backendstring required

Name of the backend used when no routing rules match the incoming request.

created_atstring date-time required

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

updated_atstring date-time required

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

Example response

[
  {
    "name": "frontend-1",
    "port": 80,
    "mode": "http",
    "default_backend": "backend-1",
    "tls_configs": [
      {
        "name": "frontend-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"
      }
    ],
    "rules": [
      {
        "name": "redirect-to-https",
        "priority": 1,
        "matching_condition": "and",
        "matchers": [
          {
            "type": "path",
            "inverse": false,
            "match_path": {
              "method": "starts_with",
              "value": "/api",
              "ignore_case": true
            }
          }
        ],
        "actions": [
          {
            "type": "set_forwarded_headers",
            "action_set_forwarded_headers": {}
          },
          {
            "type": "set_request_header",
            "action_set_request_header": {
              "header": "X-Forwarded-Proto",
              "value": "https"
            }
          },
          {
            "type": "http_redirect",
            "action_http_redirect": {
              "location": "https://example.com",
              "status": 301
            }
          }
        ],
        "created_at": "2025-11-06T09:00:00.000Z",
        "updated_at": "2025-11-06T09:30:00.000Z"
      }
    ],
    "properties": {
      "inbound_proxy_protocol": false,
      "timeout_client": 50000,
      "http2_enabled": true,
      "frontend_id": 301
    },
    "networks": [
      {
        "name": "public-network"
      },
      {
        "name": "private-network"
      }
    ],
    "created_at": "2025-11-06T09:00:00.000Z",
    "updated_at": "2025-12-06T09:00:00.000Z"
  }
]

Changes

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