Skip to main content
GET
/
cloud
/
v1
/
l7policies
/
{project_id}
/
{region_id}
/
{l7policy_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
load_balancer_l7_policy = client.cloud.load_balancers.l7_policies.get(
    l7policy_id="023f2e34-7806-443b-bfae-16c324569a3d",
    project_id=1,
    region_id=1,
)
print(load_balancer_l7_policy.id)
{
  "action": "REDIRECT_PREFIX",
  "id": "<string>",
  "listener_id": "<string>",
  "name": "<string>",
  "operating_status": "DEGRADED",
  "position": 123,
  "project_id": 123,
  "provisioning_status": "ACTIVE",
  "redirect_http_code": 301,
  "redirect_pool_id": "00000000-0000-4000-8000-000000000000",
  "redirect_prefix": "<string>",
  "redirect_url": "<string>",
  "region": "<string>",
  "region_id": 123,
  "rules": [
    {
      "id": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123
    }
  ],
  "tags": [
    "<string>"
  ],
  "task_id": "023f2e34-7806-443b-bfae-16c324569a3d"
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID Project ID

region_id
integer
required

Region ID Region ID

l7policy_id
string
required

L7 policy ID L7 policy ID

Response

200 - application/json

OK

action
enum<string>
required

Action

Available options:
REDIRECT_PREFIX,
REDIRECT_TO_POOL,
REDIRECT_TO_URL,
REJECT
id
string
required

ID

listener_id
string
required

Listener ID

name
string
required

Human-readable name of the policy

operating_status
enum<string>
required

L7 policy operating status

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
position
integer
required

The position of this policy on the listener. Positions start at 1.

project_id
integer
required

Project ID

provisioning_status
enum<string>
required
Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
redirect_http_code
integer | null
required

Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or REDIRECT_PREFIX. Valid options are 301, 302, 303, 307, or 308. Default is 302.

Example:

301

redirect_pool_id
string | null
required

Requests matching this policy will be redirected to the pool with this ID. Only valid if action is REDIRECT_TO_POOL.

Example:

"00000000-0000-4000-8000-000000000000"

redirect_prefix
string | null
required

Requests matching this policy will be redirected to this Prefix URL. Only valid if action is REDIRECT_PREFIX.

redirect_url
string | null
required

Requests matching this policy will be redirected to this URL. Only valid if action is REDIRECT_TO_URL.

region
string
required

Region name

region_id
integer
required

Region ID

rules
L7RuleInlineSerializer · object[]
required

Rules. All the rules associated with a given policy are logically ANDed together. A request must match all the policy’s rules to match the policy.If you need to express a logical OR operation between rules, then do this by creating multiple policies with the same action.

tags
string[]
required

A list of simple strings assigned to the resource.

task_id
string<uuid4> | null
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.

Example:

"023f2e34-7806-443b-bfae-16c324569a3d"