Skip to main content
PATCH
/
tenant
/
{tenantId}
/
admin
/
blockchain
/
{blockchainId}
/
update
/
chain-explorer-enabled
Update Blockchain Explorer Enabled
curl --request PATCH \
  --url https://api.example.com/tenant/{tenantId}/admin/blockchain/{blockchainId}/update/chain-explorer-enabled \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1024,
  "blockchainId": 137,
  "isTenantChainExplorerEnabled": true
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Enables or disables chain explorer functionality for a specific blockchain within a tenant’s environment, controlling whether the tenant can access blockchain explorer features.

​
Input

Expects a JSON body containing:
  • isTenantChainExplorerEnabled (bool, required) - True to enable chain explorer, false to disable.
Path parameters:
  • tenantId (long, required) - The unique identifier of the tenant.
  • blockchainId (long, required) - The unique identifier of the blockchain.

​
Output

Returns a BlockchainBaseUpdateResponse indicating success or failure of the update operation.

​
Examples

Request 
PATCH /api/tenant/1024/admin/blockchain/137/explorer
{
  "isTenantChainExplorerEnabled": true
}
Response (200 OK) 
{
  "success": true,
  "message": "Blockchain chain explorer status updated successfully"
}

​
Errors

  • 400 Bad Request: The request parameters failed validation.
  • 401 Unauthorized: The caller is not authenticated.
  • 403 Forbidden: The caller is not authorized to update blockchain configurations.
  • 404 Not Found: The tenant or blockchain could not be found.
  • 500 Internal Server Error: An unexpected server error occurred.

​
Notes

Chain explorer features allow tenants to browse blockchain transactions and addresses.

Path Parameters

​
tenantId
integer<int64>
required

The unique identifier of the tenant.

​
blockchainId
integer<int64>
required

The unique identifier of the blockchain.

Query Parameters

​
api-version
string | null

Body

application/json

Model containing the new chain explorer enabled status.

Request to toggle chain explorer access for a tenant blockchain.

​
tenantId
integer<int64>

Identifier of the tenant.

Example:

1024

​
blockchainId
integer<int64>

Identifier of the blockchain network.

Example:

137

​
isTenantChainExplorerEnabled
boolean

True to enable chain explorer access, false to disable.

Example:

true

Response

Blockchain chain 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 }