Skip to main content
GET
/
platform
/
admin
/
blockchains
/
configurations
Get Blockchain Configurations
curl --request GET \
  --url https://api.example.com/platform/admin/blockchains/configurations
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Fetches the complete collection of blockchain configurations, including operational status, explorer settings, and network-specific parameters for all supported blockchains in the platform.

​
Input

No request body required. Optional cancellation token for request cancellation.

​
Output

Returns a Result object containing:
  • success (bool) — Indicates whether the retrieval operation succeeded.
  • data (array) — Collection of blockchain configuration objects, each containing:
    • blockchainId (int) — Unique identifier for the blockchain.
    • blockchainName (string) — Human-readable name of the blockchain.
    • isAdminOperationsEnabled (bool) — Whether administrative operations are enabled.
    • isAdminExplorerEnabled (bool) — Whether chain explorer integration is active.
    • networkType (string) — Network type (mainnet, testnet, etc.).

​
Examples

Request 
GET /api/platform/admin/blockchains/configurations
Response (200 OK) 
{
  "success": true,
  "data": [
    {
      "blockchainId": 1,
      "blockchainName": "Ethereum",
      "isAdminOperationsEnabled": true,
      "isAdminExplorerEnabled": true,
      "networkType": "mainnet"
    },
    {
      "blockchainId": 7,
      "blockchainName": "Polygon",
      "isAdminOperationsEnabled": false,
      "isAdminExplorerEnabled": true,
      "networkType": "testnet"
    }
  ]
}

​
Errors

  • 401 Unauthorized: Caller is not authenticated or token is invalid.
  • 403 Forbidden: Caller lacks platform administrator permissions.
  • 500 Internal Server Error: Unexpected system error occurred during retrieval.

​
Notes

This endpoint requires platform administrator privileges. Only blockchain configurations that are registered in the system will be returned.

Query Parameters

​
api-version
string | null

Response

Blockchain configurations retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object[] | null

The result value returned when the operation is successful.