TAtatum
Endpoint

Create new endpoint

Creates a new gateway endpoint. It accepts the endpoint configuration payload and registers a new endpoint within the gateway.

post/endpoint

Request

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

Request body

headersRecordHeaderKeyHeaderValue required

Construct a type with a set of properties K of type T

displayNamestring required

Human-readable name of the endpoint. This is the label that will be shown in dashboards, UIs, and other tools.

interfacestring required

Interface or protocol used by the endpoint. Examples include "ethereum-mainnet-json-rpc", "ethereum-mainnet-beacon", "polygon-mumbai-json-rpc", etc.

isActiveboolean required

Indicates whether the endpoint is currently active. Only active endpoints are considered for routing and traffic.

urlstring required

URL of the endpoint. This is the base URL that will be used to send requests to the endpoint.

providerstring

Optional provider name for the endpoint. his can be used to specify the infrastructure or RPC provider powering this endpoint.

Example request

{
  "displayName": "My Custom Ethereum RPC",
  "interface": "ethereum-mainnet-json-rpc",
  "url": "https://ethereum-mainnet.your.provider.io",
  "provider": "RPC Provider Name"
}

Response

The created endpoint

versionunknown required
idstring uuid required

This value is a UUID and serves as the primary key. It is used to reference and manage the endpoint later in the system.

displayNamestring required

Human-readable name of the endpoint. This is the label that will be shown in dashboards, UIs, and other tools.

chainstring required

Blockchain the endpoint is connected to. Example values include "ethereum", "polygon", etc.

networkstring required

Network of the selected blockchain. Example values include "ethereum-mainnet", "polygon-mumbai", etc.

interfacestring required

Interface or protocol used by the endpoint. Examples include "ethereum-mainnet-json-rpc", "ethereum-mainnet-beacon", "polygon-mumbai-json-rpc", etc.

isActiveboolean required

Indicates whether the endpoint is currently active. Only active endpoints are considered for routing and traffic.

urlstring required

URL of the endpoint. This is the base URL that will be used to send requests to the endpoint.

headersRecordHeaderKeyHeaderValue required

Construct a type with a set of properties K of type T

ownerIdstring required

Identifier of the owner of this endpoint. Typically this is the ID of the customer, account, or organization that created and manages the endpoint.

providerstring

Optional provider name for the endpoint. his can be used to specify the infrastructure or RPC provider powering this endpoint.

createdAtstring date-time required

Date and time when the endpoint was created.

updatedAtstring date-time required

Date and time when the endpoint was last updated.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "displayName": "My Custom Ethereum RPC",
  "chain": "ethereum",
  "network": "ethereum-mainnet",
  "interface": "ethereum-mainnet-json-rpc",
  "url": "https://ethereum-mainnet.your.provider.io",
  "ownerId": "692391f00000000000000000",
  "provider": "RPC Provider Name"
}

Changes

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