Create Rule — API

Path parameters

gateway_idPathintegerrequired
Gateway ID

Query parameters

project_idQueryintegerrequired
Project ID
locationQuerystringrequired
Location
active_iamQueryintegeroptional
Active IAM ID (To access contact person account) Find your Active IAM ID here

Request body

application/json

object

route_namestringrequired

Name of the routing rule. Must be unique within the gateway.

examplellama-route

routing_strategystringrequiredWeight-Based | Prefix-Based | Header-Based…

Traffic routing strategy.

Weight-Based — distributes traffic by weight across endpoints.
Prefix-Based — routes by URL path prefix. All referenced endpoints must be in READY status.
Header-Based — routes by matching HTTP request headers.
Path-Based — routes by matching the full URL path.

statusstringActive | Inactive

Initial status of the rule.

exampleActive

rulesobject

Routing configuration.

Responses

200Routing rule details.

object

codeinteger

example200

dataobject

errorsobject

messagestring

exampleSuccess

Request

curl -X POST 'https://api.e2enetworks.com/myaccount/api/v1/gpu/gateway/{gateway_id}/rules/?project_id=%3Cproject_id%3E&location=%3Clocation%3E&active_iam=%3Cactive_iam%3E&apikey=%3Capikey%3E' \
  -H 'Authorization: Bearer <JWT>' \
  -H 'Content-Type: application/json' \
  -d '{
  "route_name": "llama-route",
  "routing_strategy": "string",
  "status": "Active",
  "rules": {
    "path": "/v1/chat",
    "headers": [
      {
        "key": "x-model",
        "type": "Exact",
        "value": "llama"
      }
    ],
    "endpoints": [
      {
        "id": 3036,
        "weight": 70
      },
      {
        "id": 3035,
        "weight": 20
      },
      {
        "id": 3037,
        "weight": 10
      }
    ]
  }
}'

Response · 200

{
  "code": 200,
  "data": {
    "id": 5,
    "route_name": "llama-route",
    "routing_strategy": "Weight-Based",
    "rules": {
      "path": "/v1/chat",
      "headers": [
        {
          "key": "x-model",
          "type": "Exact",
          "value": "llama"
        }
      ],
      "endpoints": [
        {
          "id": 3036,
          "weight": 100
        }
      ]
    },
    "status": "Active",
    "created_by": {
      "id": 101,
      "name": "John Doe",
      "email": "user@example.com",
      "username": "user@example.com"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  "errors": {},
  "message": "Success"
}