Unpledge

Basic Description

This endpoint is used to create an unpledge in Taurus-NETWORK. An unpledge may be done to any participant of Taurus-NETWORK, so long as a pledge has taken place between the two participants beforehand.

This endpoint would accept a POST request.

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:

• 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. This one only requires the a UUID for the pledge in the Request URL: https://tg-validatord-cockroach-3d018ae288493150.acc.t-dx.com/api/rest/v1/tn/pledges/56e90280-458d-4a75-a8d4-1d9c8e9570b8/unpledge

📘

Preconditions

You must first have pleged to create an unpledge.

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/tn/pledges/56e90280-458d-4a75-a8d4-1d9c8e9570b8/unpledge" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \

This piece of code sends a POST request to https://your-protect-instance.example.com/api/rest/v1/tn/pledges/56e90280-458d-4a75-a8d4-1d9c8e9570b8/unpledge

👍

Call Result

A successful response for the POST call to unpledge might look like this:

{"pledgeActionID":"eb1df8d1-7d1f-47d9-a8aa-7824bbc493f9"}

In this example, Taurus-PROTECT has made an unpledge request in Taurus-NETWORK.

Requirements for Future Use

For this particular endpoint, we do not have any storage requirements.

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