This API helps to manage remote brokers for access broker.
1. Get Remote Broker Details by Page
This GET method is used to retrieve the broker details.
| GET | {{url}}/api/resource-manager/remote-broker/brokers |
Request Parameters
The request parameters used in this method are shown in the following table:
| Parameter | Description | Data Type | Required |
| pageSize | Specifies the page size, the default is ten. | Integer | Optional |
| exclusiveStartKey | Specifies the exclusive start key used for pagination. | String | Optional |
Request Example
An example GET request for retrieving remote broker details is shown here.
curl --location --request GET '{{url}}/resource-manager/remote-broker/brokers?pageSize={{page_number}}&exclusiveStartKey={{string}}' \
--header 'Authorization: TOKEN {{apiToken}}'Response Example
An example response of the GET request for retrieving broker details is shown here.
| Status: 200 OK |
{
"data": [
{
"pool-id": "string",
"pool-name": "string",
"broker-id": "string",
"broker-key": "string",
"broker-name": "string",
"status": "string",
"status-timestamp": "string",
"created": "string"
},
{
"pool-id": "string",
"name": "string",
"description": "string",
"broker-count": 0,
"keep-alive-seconds": 60,
"disconnect-seconds": 86400
}
],
"lastEvaluatedKey": "string",
"resultSize": 0
}