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

Description

Enables or disables blockchain operations for a specific blockchain within a tenant’s environment, controlling whether the tenant can perform transactions on this blockchain.

Input

Expects a JSON body containing:
  • isTenantOperationsEnabled (bool, required) - True to enable operations, 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/operations
{
  "isTenantOperationsEnabled": true
}
Response (200 OK)
{
  "success": true,
  "message": "Blockchain operations 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

Disabling operations prevents the tenant from creating new transactions on this blockchain.

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 operations enabled status.

Request to toggle blockchain operations for a tenant on a specific network.

tenantId
integer<int64>

Identifier of the tenant.

Example:

1024

blockchainId
integer<int64>

Identifier of the blockchain network.

Example:

137

isTenantOperationsEnabled
boolean

True to enable blockchain operations, false to disable.

Example:

true

Response

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