Agent Groups (REST)

The AppMon Server offers several RESTful interfaces to manage Agent Groups of a System Profile and their agent mappings.

GET Agent Groups list

Lists all configured Agent Groups of a certain System Profile.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/agentgroups
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/agentgroups
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/agentgroups

PUT Agent Group

Creates an Agent Group with the specified name in the specified System Profile. If such a group already exists, it will be overwritten.

The request can copy the group from the specified System Profile template.

The interface does not evaluate agentmappingsreference elements. Use the HTTP PUT interface for Agent Mappings.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/agentgroups/{groupname}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/agentgroups/{groupname}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/agentgroups/{groupname}

GET Agent Group

Produces the JSON description of the specified Agent Group in the specified System Profile.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/agentgroups/{groupname}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/agentgroups/{groupname}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/agentgroups/{groupname}

DELETE Agent Group

Deletes the specified Agent Group from the specified System Profile.

DELETE
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/agentgroups/{groupname}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/agentgroups/{groupname}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/agentgroups/{groupname}

Agent mappings

Similar to the interfaces for Agent Groups, the AppMon Server offers several interfaces to manage Agent Mappings. See Agent Groups mapping (REST) for details.