Update gateway

patch

https://api.tatum.io/v4/manage/gateway/{id}

Updates an existing gateway by its ID.

Path Params

uuid

required

Body Params

displayName

string

length between 1 and 100

Human-readable name of the gateway. Displayed in dashboards, APIs, and management interfaces.

isActive

boolean

Indicates whether the gateway is currently active and processing traffic.

endpointConfigs

array

length ≤ 10

Configuration of endpoints associated with this gateway. Defines how individual endpoints participate in routing, including their priority, weight, and enabled status. Maximum of 10 endpoints per gateway.

endpointConfigs

endpointRouting

string

The strategy used for routing traffic across configured endpoints.

"priority-failover": Traffic is routed to the highest-priority healthy endpoint first. If it becomes unavailable, traffic automatically fails over to the next endpoint based on priority.
"load-distribution": Traffic is distributed across all enabled endpoints according to their defined weights (typically weighted round-robin).

enabledPowerups

object

Optional performance and reliability features enabled for the gateway.

methodRoutingOverrides

array of objects

Override configurations for specific methods of this gateway.

methodRoutingOverrides

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated gateway

400Bad request

401Unauthorized

403Forbidden

404Not found