Sign in

v6

latestOpenAPI 3.0.3raw.githubusercontent.com2025-11-28172255.4 KB
Gateways

Update a gateway

Updates an existing gateway's configuration.

patch/gateway/{gateway_topic}

Path parameters

gateway_topicstring required

Unique topic identifier of the gateway

Request body

namestring

Updated name of the gateway

descriptionstring

Updated description of the gateway

activeboolean

Whether the gateway is active

timeoutinteger

Updated timeout in milliseconds for gateway requests

Example request

{
  "name": "Updated Gateway Name",
  "description": "Updated description for my gateway",
  "active": true,
  "middleware": [
    {
      "order": 1,
      "resource": "auth-middleware",
      "resource_type": "function",
      "resource_version": "latest",
      "type": "pre-request"
    }
  ],
  "limit": {
    "request": 5000,
    "time": 1000
  },
  "timeout": 60000
}

Response

Gateway updated successfully

messagestring

Example response

{
  "message": "success"
}