Agent Groups (REST)

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

Agent groups

These requests handle Agent Group operations

GET Agent Groups list

Lists all configured Agent Groups of a certain System Profile.

GET
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups
produces application/json

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.

PUT
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups/<groupname>
consumes application/json

GET Agent Group

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

GET
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups/<groupname>
produces application/json

DELETE Agent Group

Deletes the specified Agent Group from the specified System Profile.

DELETE
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups/<groupname>

Agent mappings

Similar to the interfaces for Agent Groups, the AppMon Server offers several interfaces to manage Agent Mappings. Use HTTP GET to request the details of an Agent Mapping. Use HTTP methods PUT and DELETE to create, modify, and delete Agent Mappings. Use the Lists interface to get a list of configured Agent Mappings for a certain Agent Group.

These interfaces manages Agent Group mapping operations.

GET Agent Group mappings

GET
https://<server>8021/api/v3/profiles/<profileid>/agentgroups/<groupname>/mappings
produces application/json

Lists all configured Agent Mappings of a certain Agent Group.

PUT Agent mapping

Creates a new agent mapping in the specified Agent Group. If such a mapping already exists, it will be overwritten. The request must send a JSON representation of the Agent Mapping. See the Parameters section for description. See also Agent Group - Agent Mapping.

PUT
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups/<groupname>/mappings/<mappingalias>
consumes application/json

GET Agent mapping

Produces the JSON description of the specified agent mapping from the specified Agent Group.

GET
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups/<groupname>/mappings/<mappingalias>
produces application/json

DELETE Agent mapping

Deletes the specified agent mapping from the specified Agent Group.

DELETE
https://<server>:8021/api/v3/profiles/<profileid>/agentgroups/<groupname>/mappings/<mappingalias>