Get Broker Servers
get
/api/broker/Servers
Gets the broker servers that match the specified parameters. If no parameters are specified, all broker servers are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : brokerServersRead
Type:
Show Source
object
-
BootTime: string
The boot time represented as a Unix timestamp.Example:
1689091296
-
BrokerLogLevel: integer
The log level of the broker on the server. Allowed Values: - 0 => OFF - 1 => FATAL - 2 => ERROR - 3 => WARN - 4 => INFO - 5 => DEBUGExample:
0
-
BrokerThreads: integer
The broker worker threads on the server.Example:
20
-
CustomName: string
The custom name of the server.Example:
CustomServer
-
IsDatabase: string
Denotes whether it is a Database Server or notExample:
No
-
IsPresentation: string
Denotes whether it is a Presentation Server or notExample:
No
-
LogRotateCount: integer
The number of rotated logs to keep on the server.Example:
5
-
LogRotateSize: number
The minimum size in megabytes of the logs before rotation on the server.Example:
50
-
PrimaryServerID: integer
The primary server ID if this server is redundant.Example:
2
-
RedundantServerCount: string
The number of redundant servers.Example:
2
-
roles: array
roles
The array of server roles.
-
ServerCategoryID: integer
The server category ID. Allowed Values: - 1 => Collection - 2 => Database - 3 => PresentationExample:
1
-
ServerCategoryName: string
Server Category Name denotes the server's primary role. Possible Values: - Collection - Database - PresentationExample:
Primary
-
ServerHostFQDN: string
Server HostFQDN making requestExample:
server.com
-
ServerID: integer
The server ID.Example:
1
-
ServerPlatformName: string
The server platform name.Example:
EXL8
-
State: string
Indicator of the Server stateExample:
Unknown
-
StatusID: integer
The status ID. Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
subroles: object
subroles
The object denoting different main server roles and their respective subroles.
-
Timezone: string
The server timezone.Example:
GMT+5:30
-
Version: string
The version of the application under use.Example:
6.0.4.0.0
-
ZoneID: integer
The zone ID.Example:
1
Nested Schema : subroles
Type:
object
The object denoting different main server roles and their respective subroles.
Show Source
-
Cluster: array
Cluster
The array of available subroles for the server main role Cluster.
-
Collection: array
Collection
Array of available subroles for the server main role Collection
-
Database: array
Database
Array of available subroles for the server main role Database
-
Presentation: array
Presentation
Array of available subroles for the server main role Presentation
-
Processing: array
Processing
Array of available subroles for the server main role Processing
-
Vision: array
Vision
Array of available subroles for the server main role Vision
Nested Schema : items
Type:
Show Source
object
-
id: integer
The server role ID.Example:
2
-
role: string
The role name.Example:
Cluster
-
selected: boolean
Denotes whether a particular server role is selectedExample:
1
-
serverID: integer
The server ID.Example:
4
-
subrole: string
The sub role name.Example:
Internal
-
version: string
The version of the application under use.Example:
6.0.4.0.0
Nested Schema : Cluster
Type:
array
The array of available subroles for the server main role Cluster.
Show Source
Nested Schema : Collection
Type:
array
Array of available subroles for the server main role Collection
Show Source
Nested Schema : Database
Type:
array
Array of available subroles for the server main role Database
Show Source
Nested Schema : Presentation
Type:
array
Array of available subroles for the server main role Presentation
Show Source
Nested Schema : Processing
Type:
array
Array of available subroles for the server main role Processing
Show Source
Nested Schema : Vision
Type:
array
Array of available subroles for the server main role Vision
Show Source
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object