Gateways

Update a gateway

Updates an existing gateway's configuration.

patch/gateway/{gateway_topic}

Request

Base URL
https://api.quiva.ai
Auth
- HTTP bearer
- or API key in header x-api-key
TypeScript
https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-4/docs/gateway/:gateway_topic/patch.ts
A function with typed inputs. Its response is checked against the schema.

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"
}

Changes

No recorded changes to this operation across all 8 revisions of this API.