[Webinar] Discover key trends and best practices in Kubernetes observability with DevOps expert, Viktor Farcic.Register now
Our recognition in the inaugural Gartner MQ for DEM

List Actions API

This API lists all the actions configured for the monitors associated to the users. The details of each action is grouped according to the action type.

Syntax

API for XML Response:

https://[HOST]:[PORT]/AppManager/xml/ListActions?apikey=[ API Key ]&type=all

API for JSON Response:

https://[HOST]:[PORT]/AppManager/json/ListActions?apikey=[ API Key ]&type=all

Supported HTTP methods: GET

Allowed roles: Admin, EnterpriseAdmin, Delegated Admin, Operator and Users

In future versions the following features will be included:

i) Listing Actions will be supported in Central Server.

ii) Listing Actions based on the type.

Request Parameters

FieldDescription
type This value specifies the type of action to be listed, to get all types of actions, we need to pass 'all' as the value for the field type. (In absence of this parameter also it will return all the types)

Response Details

FieldDescription
DisplayName This is the displayname of the action.
Action ID - Represents the Action ID
ExecuteActionPath - Represents the uri for executing the action
NAME - Represents the Name of the Action
ActionProps - Represents the Action Properties like From Address, To Address, Message etc., this changes for each and every action type
USEDBY - Represents the action association count
EDITURL - Represents the edit page url of the particular action.
BUSINESSHOURDETAILS - Represents the business hour details configured for the particular action.
allowedActionTypes - Represents the allowed status of the action types for Delegated administrator users.

Sample Request

XML Input:

https://apm-prod-server:8443/AppManager/xml/ListActions?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=all

XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<AppManager-response uri="/AppManager/xml/ListActions">
<result>
<response response-code="4000">
<Actions DisplayName="SMS Action(s)"> <Action EDITURL="/adminAction.do?method=showSMSAction&actionID=10000003"
ExecuteActionPath="/common/executeSMS.do?method=testAction&remote=true&actionID=10000003"
ID="10000003" NAME="Test SMS" USEDBY="0">
<BUSINESSHOURDETAILS ID="10000000" description="" fridayEndHour="20"
fridayEndMinute="0" fridayStartHour="8" fridayStartMinute="0"
mondayEndHour="20" mondayEndMinute="0" mondayStartHour="8" mondayStartMinute="0" name="Test BH"
saturdayEndHour="0"saturdayEndMinute="0" saturdayStartHour="0"saturdayStartMinute="0"
sundayStartHour="0"sundayStartMinute="0" thursdayEndHour="20"thursdayEndMinute="0"
selectedDays="Monday,Tuesday,Wednesday,Thursday,Friday" sundayEndHour="0" sundayEndMinute="0"
thursdayStartHour="8" thursdayStartMinute="0" tuesdayEndHour="20" tuesdayEndMinute="0"
tuesdayStartHour="8" tuesdayStartMinute="0" type="1" wednesdayEndHour="20" wednesdayEndMinute="0"
wednesdayStartHour="8" wednesdayStartMinute="0"/>
<ActionProps FROMADDRESS="-" MESSAGE="This information has been generated by the Applications
Manager" TOADDRESS="**********"/>
</Action>
</Actions>
</response>
</result>
</AppManager-response>

JSON Input:

https://apm-prod-server:8443/AppManager/json/ListActions?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=all

JSON Response

{"response-code":"4000","response":{"result"[{"Action":
[{"USEDBY":"0","ID":"10000004","ExecuteActionPath":"/common/executeAction.do
method=testAction&remote=true&actionID=10000004","EDITURL":"/adminAction.do?
method=showEmailAction&actionID=10000004","BUSINESSHOURDETAILS":
{"mondayStartMinute":"0","tuesdayEndMinute":"0","sundayStartMinute":"0","saturdayEndHour":"0","sundayStartHou
r":"0","thursdayStartMinute":"0","type":"1","mondayEndHour":"20","saturdayStartMinute":"0","ID":"10000000","wednes
dayStartHour":"8","selectedDays":"Monday,Tuesday,Wednesday,Thursday,Friday","wednesdayEndMinute":"0","satur
dayStartHour":"0","tuesdayStartMinute":"0","thursdayStartHour":"8","thursdayEndHour":"20","sundayEndMinute":
"0","tuesdayStartHour":"8","fridayEndHour":"20","tuesdayEndHour":"20","mondayStartHour":"8","wednesdayEndHour":"2
0","fridayStartMinute":"0","mondayEndMinute":"0","description":"","sundayEndHour":"0","wednesdayStartMinute":"0","
fridayStartHour":"8","saturdayEndMinute":"0","fridayEndMinute":"0","thursdayEndMinute":"0","name":"Test
BH"},"NAME":"Test Email DA","ActionProps":
{"FROMADDRESS":"user@zohomail.com","TOADDRESS":"user@zohomail.com","SUBJECT":"Alarm from the
Applications Manager"}}],"DisplayName":"E-mail Action(s)"},{"allowedActionTypes":[{"delAdmin_vm":"true","delAdmin_windows":"true","delAdmin_trap":"true","delAdmin_slack":"true","delAdmin_sqlJobAction":"true","delAdmin_restapi":"true","delAdmin_container":"true","delAdmin_heap":"true","delAdmin_sendEmail":"true","delAdmin_sms":"true","delAdmin_program":"true","delAdmin_amazon":"true","delAdmin_mbean":"true","delAdmin_sdp":"true"}]}],"uri":"/AppManager/json/ListActions"}}

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.
Back to Top