Agents (REST)

AppMon 2018 October

These REST interface is available in the AppMon 2018 October only.

You can enforce Agents to use the specific versions of the Agent. These REST API calls allows you to check which Agents and which versions are available on your Server, and configure Agents and/or Agent Groups to use the specific versions of Agents. Alternatively you can make it in the Agents Overview dashlet of the AppMon Client.

GET Agents list

Lists all Agents registered on the Server. You may narrow down the result to Agents, mapped to a specific System Profile.

The request produces application/json.

GET
https://<server>:8021/api/v4/agents

GET Agents versions

Lists all available versions of Agents, registered on the Server.

The request produces application/json.

GET
https://<server>:8021/api/v4/agentversion/versions

Agent version—Agent Group

One of the ways to enforce Agents to use the specific version, is to set it on the Agent Group level. In that case all the Agents, mapped to this group will use the specified Agent version. These requests allow you to manage Agent Group version mappings.

GET Agent Group version mappings

Lists all Agent Group version mappings.

The request produces application/json.

GET
https://<server>:8021/api/v4/agentversion/agentgroupmappings

POST Agent Group version mappings

Updates Agent Group version mappings. You can update one Agent Group version mapping at time. Mappings which are not specified in the body of the request remain unaffected.

The request consumes application/json.

POST
https://<server>:8021/api/v4/agentversion/agentgroupmappings

DELETE Agent Group version mappings

Deletes Agent Group version mappings. You can narrow down the deletion to a specific System Profile and Agent Group. If you specify several criteria, the AND logic applies.

DELETE
https://<server>:8021/api/v4/agentversion/agentgroupmappings

Agent version—Agent

One of the ways to enforce Agents to use the specific version, is to set it on the Agent level. In that case only the configured Agents must use the specified Agent version. Any other Agents remain unaffected. These requests allow you to manage Agent version mappings.

GET Agent version mappings

Lists all Agent version mappings.

The request produces application/json.

GET
https://<server>:8021/api/v4/agentversion/agentmappings

POST Agent version mappings

Updates Agent version mappings. You can update one Agent version mapping at time. Mappings which are not specified in the body of the request remain unaffected.

The request consumes application/json.

POST
https://<server>:8021/api/v4/agentversion/agentmappings

DELETE Agent version mappings

Deletes Agent Group version mappings. You can narrow down the deletion to a specific System Profile, Agent, host, and technology. If you specify several criteria, the AND logic applies.

DELETE
https://<server>:8021/api/v4/agentversion/agentmappings