Blockchain link (Beta)

Create a new blockchain

Registers a new tenant-managed blockchain from the supplied declared properties. The blockchain starts in the CREATED state and must be activated separately before it can be used.

post/blockchain_link/blockchains

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

Example request

{
  "declaredProperties": {
    "chainName": "Ethereum",
    "chainId": 1,
    "symbolName": "ETH",
    "decimals": 18,
    "rpcUrls": [
      "https://rpc.example.com"
    ],
    "environmentType": "ENVIRONMENT_TYPE_MAINNET",
    "blockExplorerUrl": "https://etherscan.io",
    "blockExplorerTransactionPath": "/tx",
    "blockExplorerAddressPath": "/address",
    "networkId": 1,
    "hasFee": true,
    "nodeType": "NODE_TYPE_CORE_GETH",
    "baseAssetTenantIds": [
      "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    ],
    "explorerApiUrl": "https://api.etherscan.io",
    "explorerApiKey": "my-explorer-api-key",
    "rpcAuth": {
      "type": "RPC_AUTH_BASIC",
      "username": "rpc_user",
      "password": "my-password",
      "token": "my-bearer-token",
      "headerName": "X-Custom-Auth",
      "headerValue": "my-header-value"
    }
  }
}

Response

OK

messagestring required

Human-readable result message.

Example response

{
  "blockchain": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "blockchainState": "BLOCKCHAIN_STATE_ACTIVATED",
    "declaredProperties": {
      "chainName": "Ethereum",
      "chainId": 1,
      "symbolName": "ETH",
      "decimals": 18,
      "rpcUrls": [
        "https://rpc.example.com"
      ],
      "environmentType": "ENVIRONMENT_TYPE_MAINNET",
      "blockExplorerUrl": "https://etherscan.io",
      "blockExplorerTransactionPath": "/tx",
      "blockExplorerAddressPath": "/address",
      "networkId": 1,
      "hasFee": true,
      "nodeType": "NODE_TYPE_CORE_GETH",
      "baseAssetTenantIds": [
        "f47ac10b-58cc-4372-a567-0e02b2c3d479"
      ],
      "explorerApiUrl": "https://api.etherscan.io",
      "explorerApiKey": "my-explorer-api-key",
      "rpcAuth": {
        "type": "RPC_AUTH_BASIC",
        "username": "rpc_user",
        "password": "my-password",
        "token": "my-bearer-token",
        "headerName": "X-Custom-Auth",
        "headerValue": "my-header-value"
      }
    },
    "createdAtUtc": 1700000000000,
    "updatedAtUtc": 1700000000000,
    "validationSessionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "validationStatus": "VALIDATION_STATUS_SUCCEEDED",
    "validationCreatedAtUtc": 1700000000000,
    "validationUpdatedAtUtc": 1700000000000,
    "validationCompletedAtUtc": 1700000000000,
    "validationFailureReasons": [
      "RPC endpoint unreachable"
    ],
    "failedStep": "FAILED_STEP_CONFIGURATION"
  },
  "message": "Blockchain created successfully"
}

Changes

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