Gateway

Create new gateway

Creates a new gateway for the given owner. It accepts the gateway configuration payload and registers a new gateway.

post/gateway

Request

Base URL
https://api.tatum.io/v4/manage
URL
https://api.tatum.io/v4/manage/gateway
Auth
API key in header x-api-key

Request body

displayNamestring required

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

interfacestring required

Interface or protocol used by this gateway. Examples include "ethereum-mainnet-json-rpc", "polygon-mumbai-json-rpc", etc.

isActiveboolean required

Indicates whether the gateway is currently active and processing traffic.

endpointRoutingstring required

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).

Example request

{
  "displayName": "My Ethereum Mainnet Gateway",
  "interface": "ethereum-mainnet-json-rpc",
  "endpointConfigs": [
    {
      "endpointId": "905f2b80-c120-4862-8ac6-ce4e3e86d7b3",
      "weight": 100,
      "priority": 1
    }
  ],
  "methodRoutingOverrides": [
    {
      "endpointConfigs": [
        {
          "endpointId": "905f2b80-c120-4862-8ac6-ce4e3e86d7b3",
          "weight": 100,
          "priority": 1
        }
      ]
    }
  ]
}

Response

The created gateway

versionunknown required

idstring uuid required

Unique identifier of the gateway. This UUID is used to reference and manage the gateway.

urlstring required

The primary URL that clients use to send requests to the gateway.

displayNamestring required

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

chainstring required

Blockchain this gateway is connected to. Examples: "Ethereum", "Polygon", "Solana", etc.

networkstring required

Network of the blockchain. Examples: "ethereum-mainnet", "polygon-mumbai", etc.

interfacestring required

Interface or protocol used by this gateway. Examples include "ethereum-mainnet-json-rpc", "polygon-mumbai-json-rpc", etc.

isActiveboolean required

Indicates whether the gateway is currently active and processing traffic.

endpointRoutingstring required

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).

ownerIdstring

Identifier of the owner of this gateway. If not set, the gateway is an official Tatum gateway.

createdAtstring date-time required

Date and time when the gateway was created.

updatedAtstring date-time required

Date and time when the gateway was last updated.

Example response

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "url": "https://f47ac10b-58cc-4372-a567-0e02b2c3d479.gateway.tatum.io",
  "displayName": "My Ethereum Mainnet Gateway",
  "chain": "ethereum",
  "network": "ethereum-mainnet",
  "interface": "ethereum-mainnet-json-rpc",
  "endpointConfigs": [
    {
      "endpointId": "905f2b80-c120-4862-8ac6-ce4e3e86d7b3",
      "weight": 100,
      "priority": 1
    }
  ],
  "methodRoutingOverrides": [
    {
      "endpointConfigs": [
        {
          "endpointId": "905f2b80-c120-4862-8ac6-ce4e3e86d7b3",
          "weight": 100,
          "priority": 1
        }
      ]
    }
  ],
  "ownerId": "692391f00000000000000000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.