v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Load Balancers

Get load balancer L7 rule

get/cloud/v1/l7policies/{project_id}/{region_id}/{l7policy_id}/rules/{l7rule_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

l7policy_idstring required

L7 policy ID

Example:023f2e34-7806-443b-bfae-16c324569a3d

L7 policy ID

l7rule_idstring required

L7 rule ID

Example:023f2e34-7806-443b-bfae-16c324569a3d

L7 rule ID

Response

OK

compare_type'CONTAINS' | 'ENDS_WITH' | 'EQUAL_TO' | 'REGEX' | 'STARTS_WITH' required
idstring required

L7Rule ID

invertboolean required

When true the logic of the rule is inverted. For example, with invert true, 'equal to' would become 'not equal to'. Default is false.

keystring nullable required

The key to use for the comparison. For example, the name of the cookie to evaluate.

operating_status'DEGRADED' | 'DRAINING' | 'ERROR' | 'NO_MONITOR' | 'OFFLINE' | 'ONLINE' required
project_idinteger required

Project ID

provisioning_status'ACTIVE' | 'DELETED' | 'ERROR' | 'PENDING_CREATE' | 'PENDING_DELETE' | 'PENDING_UPDATE' required
regionstring required

Region name

region_idinteger required

Region ID

tagsstring[] nullable required

A list of simple strings assigned to the l7 rule

task_idstring uuid4 nullable required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

type'COOKIE' | 'FILE_TYPE' | 'HEADER' | 'HOST_NAME' | 'PATH' | 'SSL_CONN_HAS_CERT' | 'SSL_DN_FIELD' | 'SSL_VERIFY_RESULT' required
valuestring required

The value to use for the comparison. For example, the file type to compare.

Example response

{
  "id": "0ca7bebd-7a54-4977-bca7-e4ac1e612ec7",
  "invert": true,
  "key": "key",
  "project_id": 1337,
  "region": "Luxembourg 1",
  "region_id": 7,
  "tags": [
    "test_tag"
  ],
  "value": "/images*"
}