servers/list_groups

Namespace Name Admin Only Log Summary Generates Event Version Added
servers list_groups yes no Yes 1

Description

List all the current groups and which servers are associated with each group.

NOTE: Administrator access only - non-administrators will receive a 403/Forbidden error

Input Arguments

  • Required:
    • none ({})
  • Optional:
    • none ({})

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{}

Reply Example

{
  "group1" : ["server_1", "server_2"],
  "group2" : ["server_1", "server_3"],
  "group3" : ["server_4"]
}

Events

Events will be sent to all currently-connected administrators when the list of groups on the system is changed via any of the servers/groups_* API calls.

Example event message:

{
"namespace" : "event",
"name" : "servers/list_groups",
"id" : "",
"args" : {
  "group1" : ["server_1", "server_2"],
  "group2" : ["server_1", "server_3"],
  "group3" : ["server_4"]
  }
}

Log Summary

This API call does not generate a detailed log summary item

See Also