Credential Manager APIs

Credential manager REST APIs allow admin users to add, update, delete and list credential by submitting the required parameters. Credential manager APIs are designed to support GET and POST requests:

Add Credential
Edit/Update Credential
Delete Credential
List Credentials

Supported HTTP methods: GET, POST

Allowed roles: Administrator

Note:URL encoding will be required for parameters with special characters (For example: display name or password). For example, if a password contains a special character like " # , & , % or + :

# should be replaced with %23
& should be replaced with %26
% should be replaced with %25
+ should be replaced with %2B while passing the password in the REST API.

When using the Credential Manager APIs, for operations like add, edit, delete credentials, it is recommended that the POST method be used.

Add Credential Manager

This API allows an admin user to add business hours in Applications Manager. The common parameters involved in executing this API request are:

Field	Description
credentialName	Enter a unique Credential Name
type	You must specify a credential type. It should be exact same as given in syntax for each type.
credentialDescr	Credential Description
credentialID	A unique identifier set by Applications Manager for a credential.

Field	Description
Servers
Telnet	Required parameters: type username prompt password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Telnet&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&prompt=$&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Telnet&credentialDescr=Test&credentialName=Telnet&username=admin&prompt=$&password=appman
SNMP v1/v2	Required parameters: type snmpCommunityString timeout Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SNMP v1v2&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&snmpCommunityString=[COMMUNITY STRING]&timeout=[MINUTES] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SNMP v1v2&credentialDescr=Test&credentialName=Credential-SNMPv2&snmpCommunityString=public&timeout=5
SNMP v3	Required parameters: type snmpAuthProtocol snmpContextName snmpPrivPassword snmpAuthPassword snmpSecurityLevel timeout snmpUserName Syntax: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SNMP v3&snmpAuthProtocol=[MD5 or SHA]&credentialName=[CREDENTIAL NAME]&snmpContextName=[CONTEXT NAME]&snmpPrivPassword=[PRIVATE PASSWORD]&snmpSecurityLevel=[NOAUTHNOPRIV or AUTHNOPRIV or AUTHPRIV]&snmpAuthPassword=[AUTHENTICATION PASSWORD]&timeout=[MINUTES]&snmpUserName=[USERNAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&snmpAuthProtocol=MD5&credentialName=snmp-v3-1&snmpContextName=cusu4NfK6N0s6b&snmpPrivPassword=snmpappman&snmpSecurityLevel=NOAUTHNOPRIV&snmpAuthPassword=&type=SNMP v3&timeout=5&snmpUserName=snmpadmin
SSH	Required parameters: type username passphrase description prompt password sshPKAuth Syntax: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SSH&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&passphrase=[PASS PHRASE]&description=[PRIVATE KEY]&prompt=[PROMPT]&password=[PASSWORD]&sshPKAuth=on Sample Request: https://apm-prod-server:8443/AppManager/xml/credential/add?apikey=aaaaaabbbbbbccccccddddddeeeeee&credentialName=ssh-1&username=admin&passphrase=&description=&prompt=$&type=SSH&password=appman
WMI	Required parameters: type username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=WMI&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WMI&credentialDescr=Test&credentialName=WMI&username=admin&password=appman
Application servers
GlassFish	Required parameters: type Password JNDIPath UserName Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=GlassFish&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&UserName=[USERNAME]&Password=[PASSWORD]&JNDIPath=[PATH] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=GlassFish&credentialDescr=Test&credentialName=Glassfish1&UserName=admin&Password=appman&JNDIPath=/jmxrmi
JBoss Server	Required parameters: type username password sslenabled Syntax: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=JBoss Server&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&password=[PASSWORD]&sslenabled=on Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&credentialName=jboss-2&username=admin&type=JBoss Server&password=appman&sslenabled=on
Microsoft .NET	Required parameters: type username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Microsoft .NET&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&credentialDescr=[CREDENTIAL DESCRIPTION] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Microsoft .NET&credentialName=.Net1&username=admin&password=appman&credentialDescr=This is .net credential.
VMware vFabric tc Server	Required parameters: type Password JNDIPath UserName Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=VMware vFabric tc Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Password=[PASSWORD]&JNDIPath=[JNDI PATH]&UserName=[USERNAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=VMware vFabric tc Server&credentialName=vFabric1&Password=appman&JNDIPath=/jmxrmi&UserName=admin
WebLogic Server	Required parameters: type username password version Syntax https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=WebLogic Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&version=[WLS_6_1 or WLS_7_0 or WLS_8_1 or WLS_9_0 or WLS_10_0] Sample Request https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WebLogic Server&credentialName=Weblogic6.1&username=admin&password=appman&version=WLS_6_1
WebSphere Server	Required parameters: type soapport username authEnabled password sslenabled version Syntax: https://apm-prod-server:8443/AppManager/xml/credential?apikey=[APIKEY]&type=WebSphere Server&soapport=[SOAP PORT]&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&authEnabled=on&password=[PASSWORD]&version=[5 or 6 or 7 or 8]&sslenabled=on Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WebSphere Server&soapport=8880&credentialName=websphere7.x&username=admin&authEnabled=on&password=appman&version=8&sslenabled=on
Apache Server	Required parameters: type username authEnabled password sslenabled Syntax: https://apm-prod-server:8443/AppManager/xml/credential?apikey=[APIKEY]&type=Apache Server&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&authEnabled=on&password=[PASSWORD]&sslenabled=on Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Apache Server&credentialName=Apache-1&username=admin&authEnabled=on&password=appman&sslenabled=on
Tomcat Server	Required parameters: type username password sslenabled version tomcatmanagerurl Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&tomcatmanagerurl=[TOMCAT MANAGER URL]&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&type=Tomcat Server&password=[PASSWORD]&sslenabled=on&version=[3 or 4 or 5 or 6 or 7] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&tomcatmanagerurl=/manager&credentialName=Tomcat6&username=admin&type=Tomcat Server&password=appman&sslenabled=on&version=7
Java/Transactions
Java Runtime	Required parameters: type jndiurl authEnabled username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Java Runtime&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&jndiurl=[JNDIURL]&authEnabled=on&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Java Runtime&credentialName=JavaRuntime1&jndiurl=/jmxrmi&authEnabled=on&username=admin&password=appman
Services
FTP/SFTP	Required parameters: User Name Password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=FTPMonitor&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIAL NAME]&User%20Name=USERNAME&Password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=FTPMonitor&credentialDescr=FTPSample&credentialName=FTPCred&User%20Name=admin&Password=appman
Database
DB2	Required parameters: type username password instance Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=DB2&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&instance=[DB NAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=DB2&credentialName=DB2 server1&username=admin&password=appman&instance=SAMPLE
MS SQL	Required parameters: type namedInstance username authType instance password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]=MS SQL&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&namedInstance=on&authType=[SQL or Windows]&instance=[INSTANCE]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MS SQL&credentialName=SQL Server1&username=admin&namedInstance=on&authType=SQL&instance=instance&password=appman
MySQL	Required parameters: type username password instance Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MySQL&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&instance=[DB NAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MySQL&credentialName=MySQL4&username=admin&password=appman&instance=test
Oracle	Required parameters: type Password UserName Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Oracle&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Oracle&credentialName=Oracle11.0.4&username=admin&password=appman
PostgreSQL	Required parameters: type username password DBname Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=PostgreSQL&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&UserName=[USERNAME]&Password=[PASSWORD]&DBname=[DB NAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=PostgreSQL&credentialName=PostgreSQL3&UserName=admin&Password=appman&DBname=postgres
Sybase	Required parameters: type username instance password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Sybase&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&instance=[INSTANCE NAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Sybase&credentialName=Sybase server 4&username=admin&instance=test&password=appman
Redis	Required parameters: Authentication Type username password Syntax: Default Authentication http://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Redis&credentialName=Redis&AuthenticationType=[DefaultAuth]&password=appman ACL Authentication http://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Redis&credentialName=Redis&AuthenticationType=[ACLAuth]&username=admin&password=appman Sample Request: Default Authentication http://[host]:[port]/AppManager/xml/credential?apikey=[apikey]&type=Redis&credentialName=[credentialName]&AuthenticationType=[DefaultAuth]&password=[password] ACL Authentication http://[host]:[port]/AppManager/xml/credential?apikey=[apikey]&type=Redis&credentialName=[credentialname]&AuthenticationType=[ACLAuth]&username=[username]&password=[password]
MongoDB	Required parameters: type authreq username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MongoDB&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&authreq=on&username=USERNAME&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&credentialName=MongoDB7&authreq=on&type=MongoDB&username=admin&password=appman
Cassandra	Required parameters: type username authreq password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Cassandra&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=USERNAME&authreq=on&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Cassandra&credentialName=Cassandra1&username=admin&authreq=on&password=appman
Middleware/Portal
Microsoft MQ (MSMQ)	Required parameters: type Password UserName Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Microsoft MQ (MSMQ)&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Password=d6pM4M2&UserName=USERNAME Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Microsoft MQ (MSMQ)&credentialName=MSMQ4&Password=appman&UserName=admin
MS Office SharePoint	Required parameters: type Password UserName Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MS Office SharePoint&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&Password=[PASSWORD]&UserName=[USERNAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MS Office SharePoint&credentialDescr=Test&credentialName=MS Sharepoint3&Password=appman&UserName=admin
RabbitMQ	Required parameters: type Password UserName Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=RabbitMQ&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Password=[PASSWORD]&UserName=[USERNAME] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=RabbitMQ&credentialDescr=Test&credentialName=RabbitMQ5&Password=appman&UserName=admin
End User Monitoring (EUM)
LDAP	Required parameters: UserName Password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=LDAP Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Username=[USERNAME]&Password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=LDAP &credentialDescr=Ldapsample&credentialName=Ldap1&UserName=admin&Password=appman
Mail Server	Required parameters: SMTP UserName SMTP Password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MAIL-server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&SMTPUsername=[USERNAME]&SMTPPassword=[PASSWORD] https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MAIL-server &credentialDescr=Mailserversample&credentialName=Mailserver11&SMTPUserName=admin&SMTPPassword=appman
Real Browser Monitoring (RBM)	Required parameters: totpKey Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=RBM&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&totpKey=[Totp Secret Key] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=RBM&credentialDescr=RBMTwitterSecretKey&credentialName=RBM_Twitter&totpKey=UGS5OQ7MO8JM2VPV
Virtualization
VMware ESX/ESXi	Required parameters: type username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=VMWare ESX/ESXi&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=VMWare ESX/ESXi&credentialName=VMWareCM&username=admin&password=appman
ERP
SAP Business One	Required parameters: type username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SAPBusinessOne&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SAPBusinessOne&credentialName=sapb1CM&username=admin&password=appman
SAP Server	Required parameters: type username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SAP&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SAP&credentialName=sapserverCM&username=admin&password=appman
SAP CCMS	Required parameters: type username password Syntax: https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SAP&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SAP&credentialName=sapserverCM&username=admin&password=appman

Edit/Update Credential

This API allows an admin user to edit the existing credential by providing the neccessary parameters.

Syntax

For XML Response:

https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&credentialID=[CREDENTIAL_ID]&..

For JSON Response:

https://[HOST]:[PORT]/AppManager/json/credential?apikey=[APIKEY]&credentialID=[CREDENTIAL_ID]&..

Example

http://app-windows:59090/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&credentialID=10&password=newpassword

Delete Credential

We can delete a particular credential by giving its credential ID. The credential ID must be a whole number.

Syntax

For XML Response:

https://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=[TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true

For JSON Response:

https://[HOST]:[PORT]/AppManager/json/credential?apikey=[APIKEY]&type=[TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true

Example

https://apm-prod-server:8443/AppManager/xml/credential?apikey=aaaaaabbbbbbccccccddddddeeeeee&credentialID=10&TO_DELETE=true

List Credential Manager

This API allows an admin user to list down the credentials in Applications Manager in both xml and json format. The type value could be "all" or a particular type.

Syntax

For XML Response:

https://[HOST]:[PORT]/AppManager/xml/credential/list?apikey=[APIKEY]&type=[TYPE]

For JSON Response:

https://[HOST]:[PORT]/AppManager/json/credential/list?apikey=[APIKEY]&type=[TYPE]

Example

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