Get States of Broker Servers
get
/api/broker/Servers/readStates
Gets the states of broker servers that match the specified parameters. If no parameters are specified, all broker server states are returned.
Request
Query Parameters
-
ServerID(required): string
The list of server IDs.Example:
3,5,6
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 : brokerServersReadStates
Type:
Show Source
object
-
ServerID: integer
The broker server ID.Example:
1
-
State: string
Indicator of the server state. Possible Values: - Running - DownExample:
Running
-
StateIcon: string
Icon for representing the server StatesExample:
OrbGreenUp.png
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