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

Description

Enables platform administrators to update configuration settings for multiple blockchains simultaneously, including operational status and chain explorer availability.

Input

Expects a JSON body containing:
  • blockchainConfigurations (array, required) — Collection of blockchain configuration updates, each containing:
    • blockchainId (int, required) — The unique identifier of the blockchain to update.
    • isAdminOperationsEnabled (bool, optional) — Whether administrative operations should be enabled.
    • isAdminExplorerEnabled (bool, optional) — Whether chain explorer integration should be enabled.

Output

Returns a Result object containing:
  • success (bool) — Indicates whether all configuration updates were applied successfully.
  • data (object) — Response object with update confirmation details.

Examples

Request
{
  "blockchainConfigurations": [
    {
      "blockchainId": 7,
      "isAdminExplorerEnabled": true,
      "isAdminOperationsEnabled": false
    },
    {
      "blockchainId": 1,
      "isAdminExplorerEnabled": true,
      "isAdminOperationsEnabled": true
    }
  ]
}
Response (200 OK)
{
  "success": true,
  "data": {
    "updatedCount": 2,
    "message": "Blockchain configurations 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.
  • 500 Internal Server Error: Unexpected system error occurred during update.

Notes

This endpoint requires platform administrator privileges. Updates are applied atomically - if any update fails, all changes are rolled back.

Query Parameters

api-version
string | null

Body

application/json

The bulk blockchain configuration update request containing multiple configuration changes.

Request to batch update platform-managed blockchain configurations.

blockchainConfigurations
object[]

Collection of blockchain configuration updates to be applied.

Response

Configuration updates applied 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 }