Skip to main content
POST
/
api
/
v1
/
gateways
/
{gateway_id}
/
rules
cURL
curl --request POST \
  --url https://api.example.com/api/v1/gateways/{gateway_id}/rules \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "path": "<string>",
  "service_id": "<string>",
  "headers": {},
  "methods": [
    "<string>"
  ],
  "plugin_chain": [
    {
      "enabled": true,
      "id": "<string>",
      "name": "<string>",
      "parallel": true,
      "priority": 123,
      "settings": {}
    }
  ],
  "preserve_host": true,
  "retry_attempts": 123,
  "session_config": {
    "body_param_name": "<string>",
    "header_name": "<string>"
  },
  "strip_path": true,
  "trustlens": {
    "mapping": {
      "input": {
        "data_projection": {},
        "extract_fields": {}
      },
      "output": {
        "data_projection": {},
        "extract_fields": {}
      }
    },
    "team_id": "<string>",
    "type": "<string>"
  },
  "type": "<string>"
}
'
{
  "active": true,
  "createdAt": "<string>",
  "gatewayID": "<string>",
  "headers": {},
  "id": "<string>",
  "methods": [
    "<string>"
  ],
  "name": "<string>",
  "path": "<string>",
  "pluginChain": [
    {
      "enabled": true,
      "id": "<string>",
      "name": "<string>",
      "parallel": true,
      "priority": 123,
      "settings": {}
    }
  ],
  "preserveHost": true,
  "public": true,
  "retryAttempts": 123,
  "serviceID": "<string>",
  "session_config": {
    "body_param_name": "<string>",
    "header_name": "<string>"
  },
  "stripPath": true,
  "trustLens": {
    "mapping": {
      "input": {
        "data_projection": {},
        "extract_fields": {}
      },
      "output": {
        "data_projection": {},
        "extract_fields": {}
      }
    },
    "team_id": "<string>",
    "type": "<string>"
  },
  "updatedAt": "<string>"
}

Headers

​
Authorization
string
required

Authorization token

Path Parameters

​
gateway_id
string
required

GatewayDTO ID

Body

application/json

Rule request body

​
name
string
required
​
path
string
required
​
service_id
string
required
​
headers
object
​
methods
string[]
​
plugin_chain
object[]
​
preserve_host
boolean
​
retry_attempts
integer
​
session_config
object
​
strip_path
boolean
​
trustlens
object
​
type
string

Response

Rule created successfully

​
active
boolean
​
createdAt
string
​
gatewayID
string
​
headers
object
​
id
string
​
methods
string[]
​
name
string
​
path
string
​
pluginChain
object[]
​
preserveHost
boolean
​
public
boolean
​
retryAttempts
integer
​
serviceID
string
​
session_config
object
​
stripPath
boolean
​
trustLens
object
​
type
enum<string>
Available options:
agent,
endpoint
​
updatedAt
string