TAtatum
Endpoint

Tests endpoint connection

Sends the provided endpoint configuration for verification before the endpoint is created or saved. This allows clients to ensure that the target endpoint is reachable and functioning as expected.

post/endpoint/test

Request

  • Base URL
    https://api.tatum.io/v4/manage
  • URL
    https://api.tatum.io/v4/manage/endpoint/test
  • 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 response from the endpoint test

unknown required

Changes

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