load-balancer

List load balancer rules

Returns a list of available frontend rules by given {service-uuid} and {frontend-name}.

get/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules

Request

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

frontend-namestring required

The name of the frontend.

Example:example-frontend-1

The unique identifier for the frontend.

Response

Created

namestring required

Human-readable name assigned to the routing rule.

priorityinteger required

Priority order for rule evaluation, where lower values indicate higher priority.

matching_condition'and' | 'or' required

Logical operator determining how multiple matchers are combined (and/or).

created_atstring date-time required

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

updated_atstring date-time required

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

Example response

[
  {
    "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"
  }
]

Changes

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