Skip to main content
PATCH
/
tenant
/
{tenantId}
/
admin
/
blockchains
/
configurations
Update Blockchain Configurations
curl --request PATCH \
  --url https://api.example.com/tenant/{tenantId}/admin/blockchains/configurations \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Description

Updates multiple blockchain configuration settings for a tenant in a single operation, allowing bulk enablement or disablement of operations and chain explorer features.

Input

Expects a JSON body containing:
  • configurations (array, required) - Array of blockchain configuration updates.
    • blockchainId (long, required) - The blockchain identifier.
    • isTenantOperationsEnabled (bool, optional) - Enable or disable operations for this blockchain.
    • isTenantChainExplorerEnabled (bool, optional) - Enable or disable chain explorer for this blockchain.
Path parameter:
  • tenantId (long, required) - The unique identifier of the tenant.

Output

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

Examples

Request
PATCH /api/tenant/1024/admin/blockchain-configurations
{
  "configurations": [
    {
      "blockchainId": 137,
      "isTenantOperationsEnabled": true,
      "isTenantChainExplorerEnabled": true
    }
  ]
}
Response (200 OK)
{
  "success": true,
  "message": "Blockchain configurations 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 one or more blockchains could not be found.
  • 500 Internal Server Error: An unexpected server error occurred.

Notes

This endpoint allows bulk updates to improve efficiency when configuring multiple blockchains.

Path Parameters

tenantId
integer<int64>
required

The unique identifier of the tenant.

Query Parameters

api-version
string | null

Body

application/json

Request containing blockchain configuration updates.

Represents a request payload for updating blockchain configurations for a tenant in bulk.

tenantBlockchainConfigurations
object[]

List of blockchain configuration updates to apply.

Example:
[
{
"blockchainId": 137,
"isTenantExplorerEnabled": true,
"isTenantOperationsEnabled": true
}
]

Response

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