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

Description

Controls whether platform administrators can perform operational tasks on a specific blockchain, such as transaction management, wallet operations, and contract deployments.

Input

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

Output

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

Examples

Request
{
  "blockchainId": 7,
  "isAdminOperationsEnabled": true
}
Response (200 OK)
{
  "success": true,
  "data": {
    "message": "Blockchain operations 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 operations will prevent administrators from performing any blockchain operations until re-enabled.

Query Parameters

api-version
string | null

Body

application/json

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

Request to toggle administrator blockchain operations for a specific network.

blockchainId
integer<int64>

Identifier of the blockchain configuration to modify.

Example:

7

isAdminOperationsEnabled
boolean

True to enable administrator operations, false to disable.

Example:

true

Response

Operations 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 }