Agent Groups (REST)

Agent Groups

The AppMon Server offers several RESTful interfaces for the URL http://<server>:8020/rest/management/profiles/<profilename>/agentgroups/<groupname> to manage Agent Groups of a System Profile. Use HTTP GET to request the details of an Agent Group. Use HTTP PUT to create new Agent Groups or to modify existing Agent Groups. Use the HTTP method DELETE to delete an existing Agent Group. There is also an interface to list all Agent Groups that are configured for a certain System Profile.

List groups

This interface lists all configured Agent Groups of a certain System Profile.

GET https://<server>:8021/rest/management/profiles/<profilename>/agentgroups produces application/xml

GET group

Use HTTP GET on a specific Agent Group to get an XML representation describing the Agent Group.

GET https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname> produces application/xml

PUT group

Use the HTTP PUT interface to create or overwrite an Agent Group by sending an XML representation as content of the request. The request's expected XML structure is similar corresponding HTTP GET interface response. Permissions are required to write to the System Profile configuration. An overloading POST interface provides the same output as HTTP PUT.

PUT https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname> consumes application/xml
POST https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>?httpMethod=PUT consumes application/xml

This PUT interface does not evaluate agentmappingsreference elements. Use the HTTP PUT interface for Agent Mappings. Renaming an Agent Group is not supported by this interface.

DELETE group

Use the HTTP DELETE interface to delete an existing Agent Group. Permissions are required to modify the System Profile. An overloading POST interface provides the same output as HTTP DELETE.

DELETE https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>
POST https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>?httpMethod=DELETE

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.

List mappings

This interface lists all configured Agent Mappings of a certain Agent Group.

GET https://<server>8021/rest/management/profiles/<profilename>/agentgroups/<groupname>/mappings produces application/xml

GET mapping

Use HTTP GET on a specific Agent Mapping to get an XML representation describing the Agent Mapping.

GET https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>/mappings/<mappingalias> produces application/xml

PUT mapping

Use this HTTP PUT interface to create or overwrite an Agent Mapping. Permissions are required to write to the System Profile configuration. An overloading POST interface provides the same output as HTTP PUT.

PUT https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>/mappings/<mappingalias> consumes application/xml
POST https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>/mappings/<mappingalias>?httpMethod=PUT consumes application/xml

The request must send an XML representation of the Agent Mapping. Do a HTTP GET request for an Agent Mapping to see the required XML structure. The agentnamematchtype and hostnamematchtype elements can have one of the following values: starts, ends, contains, equals, or regex. See Agent Group - Agent Mapping. Renaming an Agent Mapping is not supported by this interface.

DELETE mapping

Use this HTTP DELETE interface to delete an existing Agent Mapping. Permissions are required to modify the System Profile. An overloading POST interface produces the same output as HTTP DELETE.

DELETE https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>/mappings/<mappingalias>
POST https://<server>:8021/rest/management/profiles/<profilename>/agentgroups/<groupname>/mappings/<mappingalias>?httpMethod=DELETE