Index

This method returns a list of connection manager groups within the organization.

Method URL
GET /api/v2/connection_manager_groups.json

Example Response

Code Status
200 OK

Response JSON

[
  {
    "id": 5,
    "name": "Windows Connection Managers",
    "organisation_id": 2,
    "status": 1,
    "connection_managers": [
        {
            "id": 1,
            "hostname": "host-name",
            "last_contact": "2016-03-16T22:19:53-07:00",
            "advertise_addrs": [
                "10.0.0.1",
                "2601:9:abba:fa0:82e6:6eff:fe04:d72a",
                "2601:9:bad0:fa0:beef:421e:40cb:5e28"
            ]
        }
    ]
  }
]

Create

This method creates a new connection manager group and returns its ID, name, and the API key used for registering connection managers in the newly created group.

Method URL
POST /api/v2/connection_manager_groups.json

Parameters

Param Type Required Notes
name string Yes The desired name of the connection manager group to be created

Example Response

Code Status
200 OK

Response JSON

{
  "id": 6,
  "name": "Connection Manager Group Name",
  "api_key": "12345667890125018190284sixtyfourcharacterlongapikey1259181721234"
}

Show

This method returns details of the connection manager group specified by the ID given in the URL.

Method URL
GET /api/v2/connection_manager_groups/1.json

Example Response

Code Status
200 OK

Response JSON

{
  "created_at": "2016-04-13T11:27:09-07:00",
  "id": 6,
  "name": "Connection Manager Group Name",
  "organisation_id": 2,
  "status": 1,
  "updated_at": "2016-04-13T11:27:09-07:00"
}