ByCloud Docs
GuidesCLIAPISDK
patch/v1/load-balancers/{load_balancer_id}/l7-policies/{l7_policy_id}

Update L7 policy

Update an L7 policy

Path Parameters

load_balancer_id

string<uuid>required

path

Load Balancer ID

Example: "550e8400-e29b-41d4-a716-446655440000"

l7_policy_id

string<uuid>required

path

L7 Policy ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Header Parameters

X-Region

stringrequired

header

Region code to query resources from. Required for all resource operations.

Example: "sao1"

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

action

stringoptional

Enum: "REDIRECT_TO_POOL", "REDIRECT_TO_URL", "REDIRECT_PREFIX", "REJECT"

position

integeroptional

redirect_pool_id

string<uuid>optional

nullable

redirect_url

stringoptional

nullable

redirect_prefix

stringoptional

nullable

redirect_http_code

integeroptional

Enum: 301, 302, 303, 307, 308

tags

arrayoptional

Responses

200

L7 policy updated

Content-Type: application/json

l7_policy

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
409

L7 policy is not in updatable state

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/load-balancers/550e8400-e29b-41d4-a716-446655440000/l7-policies/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "action": "REDIRECT_TO_POOL",
    "position": 1,
    "redirect_pool_id": "550e8400-e29b-41d4-a716-446655440000",
    "redirect_url": "string",
    "redirect_prefix": "string",
    "redirect_http_code": 301,
    "tags": [
      "web",
      "frontend"
    ]
  }'

Response

L7 policy updated

{
  "l7_policy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:loadbalancer:l7-policy:550e8400-e29b-41d4-a716-446655440000",
    "name": "redirect-to-api",
    "description": "string",
    "provisioning_status": "ACTIVE",
    "operating_status": "ONLINE",
    "listener_id": "550e8400-e29b-41d4-a716-446655440000",
    "action": "REDIRECT_TO_POOL",
    "position": 1,
    "redirect_pool_id": "550e8400-e29b-41d4-a716-446655440000",
    "redirect_url": "string",
    "redirect_prefix": "string",
    "redirect_http_code": 302,
    "rules": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tags": [
      "web",
      "frontend"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}