Getting A List Of Exchange Accounts
Basic Description
This endpoint is used to get a list of the _Exchange Accounts _ in Taurus-PROTECT.
To understand what is an _Exchange Account _ please refer to the following page in the Taurus User Guides.
This endpoint would accept a GET request with no parameters.
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
There are no Required Input Parameters for this endpoint.
Preconditions
It is important to note that if currently there are no added Exchanges Accounts within Taurus-PROTECT, the request will result in an empty list.
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.
This piece of code submits a GET request to https://your-protect-instance.example.com/api/rest/v1/exchangeaccounts with no parameters.
Call Result
A successful response for the GET call to get the list of exchange accounts l might look like this:
In this example, Taurus-PROTECT responds with a JSON object containing a list of all the added Exchange Accounts.
Requirements for Future Use
For this endpoint, the storing requirements vary according to the use case.
You can find the Swagger-generated page for this endpoint in the following link.