Skip to main content
PATCH
/
platform
/
admin
/
blockchains
/
chain-explorer-enabled
Update Explorer Enabled Status
curl --request PATCH \
  --url https://api.example.com/platform/admin/blockchains/chain-explorer-enabled \
  --header 'Content-Type: application/json' \
  --data '
{
  "blockchainId": 7,
  "isAdminChainExplorerEnabled": false
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Controls whether the platform’s chain explorer integration is active for a specific blockchain, allowing administrators to view transaction details, block information, and smart contract interactions through external blockchain explorers.

​
Input

Expects a JSON body containing:
  • blockchainId (int, required) — The unique identifier of the blockchain to update.
  • isAdminChainExplorerEnabled (bool, required) — Whether chain explorer integration should be enabled for this blockchain.

​
Output

Returns a Result object containing:
  • success (bool) — Indicates whether the explorer status was updated successfully.
  • data (object) — Response object with update confirmation details.

​
Examples

Request 
{
  "blockchainId": 7,
  "isAdminChainExplorerEnabled": false
}
Response (200 OK) 
{
  "success": true,
  "data": {
    "message": "Blockchain explorer status updated successfully"
  }
}

​
Errors

  • 400 Bad Request: Invalid payload format, missing required fields, or invalid blockchain ID.
  • 401 Unauthorized: Caller is not authenticated or token is invalid.
  • 403 Forbidden: Caller lacks platform administrator permissions.
  • 404 Not Found: Blockchain configuration with specified ID does not exist.
  • 500 Internal Server Error: Unexpected system error occurred during update.

​
Notes

This endpoint requires platform administrator privileges. Disabling the chain explorer will remove external blockchain explorer links from the administrative interface.

Query Parameters

​
api-version
string | null

Body

application/json

The explorer enabled status update request containing the blockchain ID and enabled flag.

Request to toggle administrator chain explorer integration for a blockchain.

​
blockchainId
integer<int64>

Identifier of the blockchain configuration to update.

Example:

7

​
isAdminChainExplorerEnabled
boolean

True to enable administrator chain explorer access, false to disable.

Example:

false

Response

Explorer status updated 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

The result value returned when the operation is successful.

Example:
{ "success": true }