Get Load Balancer Rule

GET

/gateway/{gateway_id}/rules/{rule_id}/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/gateway/{gateway_id}/rules/{rule_id}/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns one Rule of the Load Balancer. Needs the Read permission for Load Balancers.

Parameters

Path Parameters

gateway_id

required

integer

Load Balancer ID

rule_id

required

integer

Rule ID

Query Parameters

project_id

required

integer

Project ID

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

The Rule

Media typeapplication/json

object

code

integer

message

string

data

object

id

integer

route_name

The Rule’s name.

string

routing_strategy

Weight-Based for a Rule made without this field.

string

rules

What the Rule matches and where it sends traffic. Every part is optional; a Rule with no match conditions matches every request.

object

name

A display name for the Rule. Not set unless you send it.

string

priority

A number that breaks a tie between two equally specific Rules: the lower number is tried first. A Rule with no priority comes last among equals. A more specific match always wins over a less specific one, whatever the priority.

integer

match

Conditions that must all hold for the Rule to apply.

object

path

Match on the request path.

object

type

How value is compared with the request path.

string

Allowed values: prefix exact regex

value

The path to match, for example /api.

string

headers

Header conditions. All of them must match.

Array<object>

object

name

Header name.

string

type

Exact compares the whole value, RegularExpression matches a pattern, Present only needs the header to exist. Defaults to Exact.

string

Allowed values: Exact RegularExpression Present

value

Value to compare. Required unless type is Present.

string

query_params

Query parameter conditions. All of them must match.

Array<object>

object

name

Query parameter name.

string

type

Exact or RegularExpression. Defaults to Exact.

string

Allowed values: Exact RegularExpression

value

Value to compare. Required.

string

methods

HTTP methods to match: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, TRACE or CONNECT. The request must use one of them.

Array<string>

method

One HTTP method, as an alternative to methods.

string

groups

The backend groups the Rule sends traffic to. With more than one, traffic is split by weight. All groups of one Rule must use the same protocol (HTTP, HTTPS or gRPC).

Array<object>

object

target_group_id

ID of a backend group of this Load Balancer. Required.

integer

weight

Share of the traffic sent to this group, relative to the other groups of the Rule: a whole number, 0 or more, default 1.

integer

status

Active or Inactive.

string

Allowed values: Active Inactive

created_by

Who created it.

object

id

integer

name

string

email

string

username

string

created_at

string

updated_at

string

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 12,
    "route_name": "api-rule",
    "routing_strategy": "Weight-Based",
    "rules": {
      "name": "API traffic",
      "priority": 1,
      "match": {
        "path": {
          "type": "prefix",
          "value": "/api"
        },
        "methods": [
          "GET",
          "POST"
        ]
      },
      "groups": [
        {
          "target_group_id": 7,
          "weight": 90
        },
        {
          "target_group_id": 8,
          "weight": 10
        }
      ]
    },
    "status": "Active",
    "created_by": {
      "id": 101,
      "name": "A User",
      "email": "user@example.com",
      "username": "auser"
    },
    "created_at": "2026-10-21T11:17:29Z",
    "updated_at": "2026-10-21T11:17:29Z"
  },
  "errors": {}
}

400

project_id is missing or not a number. errors holds the project’s own text.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {}
}

404

No Load Balancer, or no Rule on it, with those IDs in the project and region. errors says which was not found.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Rule not found"
}