Disabling An Address Via A Change

Basic Description

This endpoint is used to disable an Address in Taurus-PROTECT. Disabling an address in Taurus-PROTECT means that you can no longer spent the funds held in the Address. However, the Address can still receive funds from blockchain transactions.
To understand what an Address is and how to use it, please refer to the following page in the Taurus User Guides.

This endpoint would accept a POST request with a JSON payload containing the Change with the business rule that needs to be created in order to disable the Address. The entity, action, and changes containing the addressIdand label are the three required parameters that must be included within the JSON payload. Please take a closer look to the cURL example below in this page..

❗️

Disabling an Address in Taurus-PROTECT

When an Address is disabled in Taurus-PROTECT, it means that you can no longer spent the funds held in the Address. However, the address can still receive funds from blockchain transactions.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.

Here is the list of required Roles for this particular endpoint:

• Admin
• TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

Certain API endpoints require specific input parameters. Here is the list of Required Input Parameters for this particular endpoint:

• ruleaddressid: The ID of the Address to be deactivated in Taurus-Protect.

📘

Preconditions

It is important to note that the selected Address needs to be already created in Taurus-PROTECT. If the given addressId does not exist, the request will eventually result in an error.

Call Example

You can find a basic example in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/changes" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \
--data '{
   "entity":"businessrule",
   "action":"create",
   "changes":{
      "rulevalue":"0",
      "rulekey":"coin_enabled",
      "ruleaddressid":"727188"
   }
}
'

This piece of code sends a POST request to https://your-protect-instance.example.com/api/rest/v1/changes with the JSON string in the request body.

👍

Call Result

A successful response for the POST call to disable an address might look like this:

{
    "result": {
        "id": "4601"
    }
}

In this example, Taurus-PROTECT has created a Change to disable Address 727188. Taurus-PROTECT responds with a JSON object containing the newly created Change ID. Please note that this Change then needs to be signed by an Admin for the address disabling process to be finalized.

Requirements for Future Use

For this particular endpoint, we do not have any storage requirements other than the Changeid that is included in the JSON Body Response.

You can find the Swagger-generated page for this endpoint in the following link.