RESTful API
(Feature available only in the Enterprise Edition)

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources

{
"operation" : {
"name" : "GET RESOURCES" ,
"result " : {
"status" : "Success",
"message" : "Resources fetched successfully"
},
"totalRows":3,
"Details": {
{
"RESOURCE DESCRIPTION":"CentOS Machine",
"RESOURCE NAME":"CentOS Machine",
"RESOURCE ID":"301",
"RESOURCE TYPE":"Linux",
"NOOFACCOUNTS" : "3"
},
{
"RESOURCE DESCRIPTION":"Cisco IOS Device",
"RESOURCE NAME":"Cisco IOS Device",
"RESOURCE ID":"302",
"RESOURCE TYPE":"Cisco IOS",
"NOOFACCOUNTS":"2"
},
{
"RESOURCE DESCRIPTION":"Weblogic Data Source Password",
"RESOURCE NAME":"WebLogic Server",
"RESOURCE ID":"303",
"RESOURCE TYPE":"WebLogic Server",
"NOOFACCOUNTS":"2"
} } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts

{
"operation":{
"name":"GET RESOURCE ACCOUNTLIST",
"result ":{
"status": "Success ,
"message":"Resource details with account list fetched successfully"
},
"Details":{
"RESOURCE ID":"303",
"RESOURCE NAME":"MSSQL server",
"RESOURCE DESCRIPTION" :"WebLogic Data source password",
"RESOURCE TYPE":"MS SQL server",
"DNS NAME":" sqlserver-l",
"PASSWORD POLICY":"Strong",
"DEPARTMENT": "SQL Server DBA" ,
"LOCATION":"Level 10",
"RESOURCE URL":"http://sqlserver-1/",
"RESOURCE OWNER": "admin",
"CUSTOM FIELD":{
"CUSTOMFIELDVALUE":"78336298",
"CUSTOMFIELDTYPE":"Numeric",
"CUSTOMFIELDLABEL":"License No" ,
"CUSTOMFIELDCOLUMNNAME":"COLUMN_LONG1"
},{
"CUSTOMFIELDVALUE":"Sep 10, 2013",
"CUSTOMFIELDTYPE" : "Date",
"CUSTOMFIELDLABEL":" Installed Date",
"CUSTOMFIELDCOLUMNNAME" "COLUMN_DATE1"
}, {
"CUSTOMFIELDVALUE":"Tese123$*%%,
"CUSTOMFIELDTYPE":"Password",
"CUSTOMFIELDLABEL":"Resource Password", "CUSTOMFIELDCOLUMNNAME":"COLUMN_SCHAR1"
}, {
"CUSTOMFIELDVALUE":"YES"
"CUSTOMFIELDTYPE":"Character",
"CUSTOMFIELDLABEL":"Secure Resource",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_CHAR1"
} },
"ACCOUNT LIST": {
{
"ISFAVPASS": "false",
"ACCOUNT NAME":"sysdba",
"PASSWDID":"308",
"PASSWORD STATUS":"[In Use]",
"ACCOUNT ID":"308"
}, {
"ISFAVPASS":"false",
"ACCOUNT NAME":"system",
"PASSWDID":"307"
"PASSWORD STATUS":"*****",
"ACCOUNT ID":"307"
} } } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307

{
"operation":{
"name":"GET RESOURCE ACCOUNT DETAILS",
result":{
status":"Success",
message":"Account details fetched successfully"
},
"Details":{
"DESCRIPTION":"",
"LAST ACCESSED TIME":"N/A",
"LAST MODIFIED TIME":"Sep 10, 2013 3:33 PM",
"PASSWORD STATUS":"*****",
"PASSWDID":"307",
"CUSTOM FIELD":[
{
"CUSTOMFIELDVALUE": "56455567",
"CUSTOMFIELDTYPE":"Numeric",
"CUSTOMFIELDLABEL":"Account LIC Number",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_LONG1"
}, {
"CUSTOMFIELDVALUE": "Sep 10, 2013",
"CUSTOMFIELDTYPE":"Date",
"CUSTOMFIELDLABEL":"Acc creation date",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_DATE1"
}, {
"CUSTOMFIELDVALUE": "Test12345",
"CUSTOMFIELDTYPE":"Password",
"CUSTOMFIELDLABEL":"Secondary Password",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_SCHAR1"
},{
"CUSTOMFIELDVALUE": "YES",
"CUSTOMFIELDTYPE":"Character",
"CUSTOMFIELDLABEL":"Secure Account",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_CHAR1"
} ] } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/password

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{"REASON":"Need the password to Login Windows Server","TICKETID":"7"}}}

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307/password

curl -X GET -k -H "Content-Type: text/json" -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/2/accounts/2/password --data-urlencode INPUT_DATA={"operation":{"Details":{"REASON":"Need the password to Login Windows Server"}}}

{
"operation":{
"name":"GET PASSWORD",
"result":{
"status": "Success",
"message":"Password fetched successfully"
},
"Details":{
"PASSWORD":"fqxdB7ded@4"
} } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/password

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={
"operation":{
"Details":{
"NEWPASSWORD":"Test@12345$",
"RESETTYPE":"LOCAL",
"REASON":"Password Expired",
"TICKETID":"7"
} } }

curl -X PUT -k -H "AUTHTOKEN<<Authtoken_generated_from_PMP>>" https:/<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/2/accounts/2/password --data-urlencode INPUT_DATA={"operation":{"Details":{"NEWPASSWORD":"Test12345$","RESETTYPE":"LOCAL","REASON":"test","TICKETID":"7"}}}

{
"operation":{ "name":"CHANGE PASSWORD",
"result":{
"status":"Success",
"message":"Password changed successfully"
} } }

INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Windows Server",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"Windows",
"PASSWORD":"Test123#@!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole",
"RESOURCEPASSWORDPOLICY":"Strong",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RESOURCECUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Resource",
"CUSTOMVALUE":"YES"
} ],
"ACCOUNTCUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Account",
"CUSTOMVALUE":"YES"
} ] } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources --data-urlencode "INPUT_DATA={\"operation\":{\"Details\":{\"RESOURCENAME\":\"Windows Server\",\"ACCOUNTNAME\":\"Administrator\",\"RESOURCETYPE\":\"Windows\",\"PASSWORD\" :\"Test@123\",\"RESOURCEPASSWORDPOLICY\":\"Strong\",\"ACCOUNTPASSWORDPOLICY\":\"Strong\",\"RESOURCECUSTOMFIELD\":[{\"CUSTOMLABEL\":\"Secure Resource\",\"CUSTOMVALUE\":\"YES\"}],\"ACCOUNTCUSTOMFIELD\":[{\"CUSTOMLABEL\":\"Secure Account\",\"CUSTOMVALUE\":\"YES\"}]}}}"

{
"operation":{
"name":"CREATE RESOURCE",
"result":{
"status":"Success",
"message":"Resource Windows Server has been added successfully"
} }

INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Windows Server",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"Windows",
"PASSWORD":"Test@123!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole",
"OWNERNAME":"admin",
"RESOURCECUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Resource",
"CUSTOMVALUE":"YES"
} ],
"ACCOUNTCUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Account",
"CUSTOMVALUE":"YES"
} ] } } }

INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Windows Server",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"Windows",
"PASSWORD":"Test123#@!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole",
"RESOURCEGROUPNAME":"Windows Servers",
"RESOURCECUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Resource",
"CUSTOMVALUE":"YES"
} ],
"ACCOUNTCUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Account",
"CUSTOMVALUE":"YES"
} ] } } }

INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Active Directory",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"License Store",
"PASSWORD":"Test123#@!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole"
} } }

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: multipart/form-data" -F 'file=@standalonesample.txt' -F 'INPUT_DATA={"operation":{"Details":{"RESOURCENAME":"Windows Server","ACCOUNTNAME":"Administrator","RESOURCETYPE":"File Store","PASSWORD":"Test123#@!","NOTES":"Testing API","RESOURCEURL":"http://windowsserver/adminconsole"}}}' "https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources"

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/getResourceIdAccountId? RESOURCENAME=(Resourcename)&ACCOUNTNAME=(Account name)

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" "https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/getResourceIdAccountId?RESOURCENAME=MSSQLServer&ACCOUNTNAME=system"

{
"operation":{
"name":"GET_RESOURCEACCOUNTID",
"result":{
"status":"Success",
"message":"Resource ID and account ID fetched successfully for the given resource
name and account name."
},
"Details":{
"RESOURCEID":"303",
"ACCOUNTID":"307"
} } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcename/{RESOURCENAME}

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcename/test

{"operation":{ "name": "GET_RESOURCEID", "result":{ "status": "Success", "message": "Resource ID fetched successfully for the given resource name." }, "Details":{ "RESOURCEID": "1" } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/{resourceid}

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/2

{
"operation":{
"name":"DELETE RESOURCE"
"result":{"status":"Success"
"message":"Resources deleted successfully."}
}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requestpassword

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={
"operation":{
"Details":{
PASSWDID":"1"
"REASON":"Testing"
} } }

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requestpassword?INPUT_DATA= { "operation" : { "Details":{ "REASON" : "Testing"}}}

{
"operation":{
"name":"REQUEST_PASSWORD" ,
"result":{
"status":"Success" ,
"message":"Request to view password have been raised successfully"
},
"Details":{
"STATUS" : "WAITING FOR APPROVAL / CHECKOUT" ;
} } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/passwordaccessrequests

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA= { "operation" : { "Details" : { "REASON" : "Testing", "TICKETID" : "7"}}}

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/passwordaccessrequests

{
"operation":{
"name":"GET_PASSWORDREQUEST"
"result":{
"status":"Success"
"message" : "Password Request fetched successfully"
}
"Details": {
"REQUESTER USERID":"2"
"REQUESTED BY":"guest"
"REQUESTED BY FULLNAME" : "Guest guest"
"PASSWORDREQUESTLIST" : [
{
"ACCOUNT ID" : "1"
"ACCOUNT NAME" : "ACCOUNT1"
"RESOURCE ID":"1"
"RESOURCE NAME":"apt-server1"
"PASSWD ID" : "1"
"STATUS":""
"REQUESTED TIME":"Nov 27
"REASON" : "For connecting the machine and update the PMP server".
} {
"ACCOUNT ID" : "2"
"ACCOUNT NAME" : "ACCOUNT2"
"RESOURCE ID":"2"
"RESOURCE NAME":"apt-server2"
"PASSWD ID" : "2"
"STATUS":""
"REQUESTED TIME":"Nov 28
"REASON" : "For connecting the machine and update the PMP server".
} ] } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/reject

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={
"operation":{
"Details":{
"PASSWDID":"1"
"REQUESTEDID" : "2" (userid of the request raised user)
} } }

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requester/34/reject

{
"operation":{
"name" : "ADMIN_REQUEST_REJECT"
"result" : {
"status" : "Success"
"message": "Password Rejected successfully"
} } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/approve

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requester/34/approve

{
"operation" : {
"name" : "ADMIN_REQUEST_APPROVE"
"result" : {
"status" : "Success"
"message": "Password Approved successfully"
} } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/checkin

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={
"operation":{
"Details":{
"PASSWDID" : "1"
"REQUESTEDID" : "2" (userid of the request raised user)
} }

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requester/34/checkin

{
"operation":{
"name" : "ADMIN_REQUEST_CHECKIN"
"result" : {
"status" : "Success"
"message" : "Password have been checked in successfully"
} } }

https://:<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/checkout

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA= {
"operation":{
"Details":{
"REASON":"N/A"
} } }

curl -X POST -k-H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/checkout?INPUT_DATA= { "operation" : { "Details" : { "REASON" : "N/A"}}}

{
"operation": {
"name" : "REQUEST_CHECKOUT" "result" : {
"status" : "Success"
"message" : "Password have been checked out successfully"
"Details":{
"STATUS" : "***** [checkIn]"
} } }

https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/restapi/json/v1/passwords/generate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={ "operation" : { "Details" : { "POLICY" : "Strong"}}}

{
"operation": {
"name": "GENERATE PASSWORD",
"result": {
"status": "Success",
"message": "Password generated successfully."
},
"Details": {
"PASSWORD": "u%mdh7gfN"
} } }

https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/restapi/json/v1/user

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{
"operation": {
"name": "CREATE_USER",
"result": {
"status": "Success",
"message": "User Created Successfully"
} } }

https://server-name:port/restapi/json/v1/resources/{RESOURCEID}

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={
"operation" : {
"Details": {
"RESOURCENAME" : "Test",
"LOCATION" : "4th floor",
"RESOURCEURL" : "http://test",
"RESOURCEPASSWORDPOLICY":"Strong",
"DEPARTMENT" : "Test",
"RESOURCEDESCRIPTION" : "Created for quality assurance",
"RESOURCETYPE" : "Windows",
"RESOURCECUSTOMFIELD" : [
{
"CUSTOMLABEL" : "Secure Resource",
"CUSTOMVALUE" : "YES"
} ] } } }

curl -X PUT -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1 --data-urlencode "INPUT_DATA={\"operation\":{\"Details\":{\"RESOURCENAME\":\"Test\",\"LOCATION\":\"4thfloor\",\"RESOURCEURL\":\"http://test\",\"RESOURCEPASSWORDPOLICY\":\"Strong\",\"DEPARTMENT\": \"Test\", \"RESOURCEDESCRIPTION\" : \"Created for quality assurance\", \"RESOURCECUSTOMFIELD\" : [{\"CUSTOMLABEL\" : \"Secure Resource\", \"CUSTOMVALUE\" : \"YES\" }]}}}"

{"operation":{ "name":"EDIT RESOURCE", "result":{"status":"Success","message":"Resource Test modified successfully."}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1

{ "operation":{
"name":"DELETE ACCOUNT",
"result":{"status":"Success","message":"Account Test123 deleted successfully."}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/downloadfile

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{
"Details":{
"REASON":"Need the key file to connect the remote host", //optional when reason is forced
"TICKETID":"7", // optional when ticketing system is enabled
"ISCUSTOMFIELD":"true" //optional Need to be given if the file to be downloaded is account/resource additional field file type
"CUSTOMFIELDTYPE":"ACCOUNT / RESOURCE" // optional -If its account additional field it must be ACCOUNT or if its resource
additional field it must be RESOURCE
"CUSTOMFIELDLABEL" : "LicenseFIle" // optional - Name of the resource/account additional field
} } }

curl -i -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1501/accounts/3601/downloadfile

INPUT_DATA={
"operation":{
"Details":{
"ACCOUNTLIST": [
{
"ACCOUNTNAME":"bestest013",
"PASSWORD":"Pa$$Word@124",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RECORD_RDP_SESSIONS":true,
"RECORD_CLI_SESSIONS":true,
"DISABLE_PASSWORD_RESETS":true,
"CONFIGURE_PASSWORD_RESET":true,
"ACCOUNT_RESOURCE_GROUP_IDS":["3002","3003"],
"IIS_WEB_CONFIG_RESET":true,
"IIS_APP_POOL_RESTART":true,
"IIS_APP_POOL_RESET":true,
"SERVICES_RESTART":true,
"SERVICES_RESET":true,
"SCHEDULED_TASK_RESET":true,
"NOTES":"IT Security - BES PMP API Test"
},
{
"ACCOUNTNAME":"bestest113",
"PASSWORD":"Pa$$Word@123",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RECORD_RDP_SESSIONS":true,
"RECORD_CLI_SESSIONS":true,
"DISABLE_PASSWORD_RESETS":true,
"CONFIGURE_PASSWORD_RESET":true,
"ACCOUNT_RESOURCE_GROUP_IDS":["3002","3003"],
"IIS_WEB_CONFIG_RESET":true,
"IIS_APP_POOL_RESTART":true,
"IIS_APP_POOL_RESET":true,
"SERVICES_RESTART":true,
"SERVICES_RESET":true,
"SCHEDULED_TASK_RESET":true,
"NOTES":"IT Security - BES PMP API Test"
} ] } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts --data-urlencode "INPUT_DATA={\"operation\":{ \"Details\":{ \"ACCOUNTLIST\": [{ \"ACCOUNTNAME\": \"bestest047\",\"PASSWORD\":\"Pa$$Word@123\",\"ACCOUNTPASSWORDPOLICY\":\"Strong\",\"NOTES\":\"IT Security - BES PMP API Test\"},{\"ACCOUNTNAME\":\"bestest048\", \"PASSWORD\":\"Pa$$Word@123\",\"ACCOUNTPASSWORDPOLICY\":\"Strong\",\"NOTES\":\"IT Security - BES PMP API Test\"}]}}}"

{"operation":
{"name":"ADD ACCOUNTS","result":
{"status":"Success","message":"Account added successfully"},
"Details":[
{"bestest047":{"STATUS":"Account added successfully"},
"bestest048":{"STATUS":"Account added successfully"}}]}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA=
{
"operation":{
"Details":{
"ACCOUNTNAME":"bestest013",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RECORD_RDP_SESSIONS":true,
"RECORD_CLI_SESSIONS":true,
"DISABLE_PASSWORD_RESETS":true,
"CONFIGURE_PASSWORD_RESET":true,
"ACCOUNT_RESOURCE_GROUP_IDS":["3002","3003"],
"IIS_WEB_CONFIG_RESET":true,
"IIS_APP_POOL_RESTART":true,
"IIS_APP_POOL_RESET":true,
"SERVICES_RESTART":true,
"SERVICES_RESET":true,
"SCHEDULED_TASK_RESET":true,
"NOTES":"IT Security - BES PMP API Test"
}} }

curl -X PUT -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1 --data-urlencode "INPUT_DATA={\"operation\":{ \"Details\":{\"ACCOUNTNAME\" : \"Test account\",\"ACCOUNTPASSWORDPOLICY\":\"Strong\",\"NOTES\":\"Created for quality assurance\", \"ACCOUNTCUSTOMFIELD\" : [{\"CUSTOMLABEL\" : \"Secure Account\", \"CUSTOMVALUE\" : \"YES\"}]}}}"

{"operation":{ "name":"EDIT ACCOUNT", "result":{"status":"Success","message":"Account Test account modified successfully"}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/{userid}

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/307

{"operation":{"name":"DELETE USER","result":{"status":"Success","message":"User Michael deleted Successfully"} } }

https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/restapi/json/v1/user

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{"USERNAME":"jason","FULLNAME":"Jason
Thomas","EMAIL":"jason@opmanager.com","POLICY":"Strong","ROLE":"Password
User","ISSUPERADMIN":"true|false","DEPARTMENT":"NOC","LOCATION":"Level 10 - South
Wing","ISAPIUSER":"true","HOSTNAME":"admin-2100","EXPIRYDATE":"yyyy-mm-dd|NeverExpires"}}}

{"operation":{"name":"CREATE_USER","result":{"status":"Success","message":"SUCCESS"},
"Details":{"AUTHTOKEN":"7D94xxxB-CxxB-44F5-xxxx-931xxxxxx}}}

https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/api/pki/restapi/createsshkey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"keyName":"keytest",
"passPhrase":"passPhrase",
"comment":"comment",
"length":"2048",
"keyType":"ssh-rsa"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/createsshkey?INPUT_DATA={"operation":{"Details":{"keyName":"keytest","passPhrase":"passPhrase","comment":"comment","length":"2048","keyType":"ssh-rsa"}}}

{ "name": "CreateSSHKey",
"result": {
"status": "Success",
"message": "New SSH key created successfully" }
}

https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/deleteSSHKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"key_name":"newkey1","withoutDisassociation":"true"}}}

https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/deleteSSHKey?INPUT_DATA={"operation":{"Details":{"key_name":"newkey1","withoutDisassociation":"true"}}}

{ "name": "DeleteSSHKey", "result": { "status": "Success", "message": "SSH keys newkey1 deleted successfully"}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllSSHKeys

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllSSHKeys

{ "name": "GetAllSSHKeys", "result": { "status": "Success", "message": "All SSH Keys fetched successfully" }, "totalRows": 1, "details": [ { "KeyName": "testkey", "KeyType": "ssh-rsa", "KeyLength": "2048", "FingerPrint": "SHA256:v28/AlRYrpBKjAp4JoTRphLOkFdVb1ummVcyFHSfC5I", "isPassphraseAvailable": false, "CreatedBy": "mm", "CreationTime": "Today" } ] }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getSSHKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"keyName":"key"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"key"}}}

{ "name": "GetSSHKey", "result": { "status": "Success", "message": "SSH Key testkey fetched successfully" }, "details": [ { "KeyName": "testkey", "KeyType": "ssh-rsa", "KeyLength": "2048", "FingerPrint": "SHA256:v28/AlRYrpBKjAp4JoTRphLOkFdVb1ummVcyFHSfC5I", "isPassphraseAvailable": false, "CreatedBy": "mm", "CreationTime": "Today" } ] }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/exportSSHKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"keyName":"key"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/exportSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"key"}}}

Key file

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getSSHkeysforuser

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"userName":"test","resourceName":"172.21.xxx.xx"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getSSHkeysforuser?INPUT_DATA={"operation":{"Details":{"userName":"test","resourceName":"172.21.xxx.xx"}}}

{ "name": "GetSSHKeysForUser", "result": { "status": "Success", "message": "SSH keys for user test of resource pmp-centos6 fetched successfully" }, "details": "testkey,testkey1" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllAssociatedUsers

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllAssociatedUsers

{ "name": "GetAllAssociatedUsers", "result": { "status": "Success", "message": "All associated users fetched successfully" }, "totalRows": 1, "details": [ { "UserName": "test", "ResourceName": "pmp-centos6" } ] }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{ "operation": { "Details" : { "common_name" : "*.google.com", "serial_number":"XXXXXXXXXXXXXX" } } }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getCertificate?INPUT_DATA={"operation":{"Details":{"common_name":"*.google.com","serial_number":"XXXXXXXXXXXXXX"}}}

Certificate object

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertificates

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{"withExpiryDaysLessThan":"500","withKeyLength":"1024","withSignatureAlgorithm":"SHA1"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllSSLCertificates?INPUT_DATA={"operation":{"Details":{"withExpiryDaysLessThan":"500"}}}

{ "name": "GetAllSSLCertificates", "result": { "status": "Success", "message": "All SSL Certificates fetched successfully" }, "totalRows": 2, "details": [ { "CertID": 1, "DNS Name/FQDN": "paytm.com", "Port": 443, "Common Name": "*.paytm.com", "Issuer": "GeoTrust Inc.", "FromDate": "Oct 13, 2015", "ExpiryDate": "Aug 27, 2017", "KeyStrength": "2048", "SignatureAlgorithm": "SHA256withRSA" }, { "CertID": 302, "DNS Name/FQDN": "204.141.32.155", "Port": 443, "Common Name": "*.zoho.com", "Issuer": "Sectigo Limited", "FromDate": "Jul 2, 2020", "ExpiryDate": "Sep 30, 2022", "KeyStrength": "2048", "SignatureAlgorithm": "SHA256withRSA", "serialNumber": "48f4ca7636b856af0300000000cc5801" } ] }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertsExpiryDate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllSSLCertsExpiryDate

{ "name": "GetAllSSLCertificatesExpiryDate", "result": { "status": "Success", "message": "Certificates expiry date fetched successfully" }, "totalRows": 2, "details": [ { "Common Name": "*.paytm.com","serialNumber": "XXXXXX", "ExpiryDate": "Aug 27, 2021" }, { "Common Name": "*.zoho.com", "serialNumber": "XXXXXX","ExpiryDate": "Apr 30, 2021" } ] }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificateDetails

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"common_name":"*.google.com","serial_number":"xxxxxxxxxxxx"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getCertificateDetails?INPUT_DATA={"operation": {"Details":{"common_name":"*.google.com"}}}

{ "name": "GetCertificateDetails", "result": { "status": "Success", "message": "Details of certificate *.zoho.com fetched successfully" }, "details": [ { "certtype": "Domain", "certificateTemplate": "N/A", "endpoint": { "hostName": "*.zoho.com", "port": "443", "expiry_date": "2021-04-30 05:29:59.0", "from_date": "2019-07-02 05:30:00.0", "certSignAlg": "SHA256withRSA", "Sans": "*.zoho.com,zoho.com", "serial": "8c0b04e91a1796d86d1de5e89c8b3c5c", "fingerPrint": "aeecb6227dc8adef18a8fb99465739996e2782a8", "keyalg": "RSA", "PublicKeyLength": 2048, "PrivateKey": false, "isAWS": false }, "isCertInstalledMulipleServers": false, "issuer": { "cname": "Sectigo RSA Domain Validation Secure Server CA", "org": "Sectigo Limited", "orgunit": "-" }, "issuedto": { "cname": "*.zoho.com", "org": "-", "orgunit": "Domain Control Validated" }, "intermediate": {}, "ipaddress": "204.141.32.155", "CertificateId": "302" } ] }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificateKeyStore

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{ "operation" : { "Details" : { "common_name" : "apitest", "serial_number":"XXXXXXXXXXXXXX" } } }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getCertificateKeyStore?INPUT_DATA={"operation":{"Details":{"common_name":"apitest","serial_number":"XXXXXXXXXXXXXX"}}}

KeyStore File Object

https://< Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificatePassphrase

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"common_name":"mycert","serial_number":"XXXXXXXXXXXXXX"}}}

https://< Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificatePassphrase?INPUT_DATA={"operation":{"Details":{"common_name":"mycert","serial_number":"XXXXXXXXXXXXXX"}}}

{ "name": "GetCertificatePassphrase", "result": { "status": "Success", "message": "Private key passphrase of certificate mycert is 123456789" } }

https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/addCertificate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

input data: {"operation":{"Details":{"fileType":"KEYSTORE","PASSWORD":"PASSWORD"}}}

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>> " -H 'Content-Type: multipart/form-data' -F INPUT_DATA={"operation":{"Details":{"fileType":"KEYSTORE","PASSWORD":"PASSWORD"}}} -F File=@D:/certs/newcert.keystore https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/addCertificate

{ "name": "AddCertificate",
"result":
{{"Status":"Success",
"Message": "Certificate newcert.com added successfully"} } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation": {"Details":{ "common_name" : "apitest", "serial_number" : "XXXXXXXXXXXXXX"} } }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/deleteCertificate?INPUT_DATA={"operation": {"Details":{"common_name":"apitest","serial_number":"XXXXXXXXXXXXXX"}}}

{"name":"DeleteCertificate","result":{"status":"Success","message":"Certificate apitest deleted successfully."}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/sslCertSingleDiscovery

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"HOST":"de-ubuntu10-1","TIMEOUT":"300","PORT":"<Port>"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/sslCertSingleDiscovery?INPUT_DATA={"operation":{"Details":{"HOST":"de-ubuntu10-1","TIMEOUT":"300","PORT":"<Port>"}}}

{ "name": "Get SSL Discovery", "totalRows": 1, "details": { "zoho.com": [ "SUCCESS", "SSL Certificate already available, *.zoho.com certificate found at port 443" ] } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/sslCertRangeDiscovery

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"StartIpAddress":"192.xxx.xxx.0",
"EndIpAddress":"192.xxx.xxx.3",
"TIMEOUT":"3",
"PORT":"443"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/sslCertRangeDiscovery?INPUT_DATA={"operation":{"Details":{"StartIpAddress":"192.xxx.xxx.0","EndIpAddress":"192.xxx.xxx.3","TIMEOUT":"3","PORT":"443"}}}

{ "name": "Get SSL Discovery", "totalRows": 4, "details": { "192.168.216.1": [ "FAILURE", "Connection failed,no certificate found at port 443" ], "192.168.216.0": [ "FAILURE", "Connection timed out,no certificate found at port 443" ], "192.168.216.2": [ "FAILURE", "Connection timed out,no certificate found at port 443" ], "192.168.216.3": [ "FAILURE", "Connection timed out,no certificate found at port 443" ] } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/createCSR

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"CNAME":"mytestcert",
"ALT_NAMES":"test",
"ORGUNIT":"zohocorp",
"ORG":"manageengine",
"LOCATION":"chennai",
"STATE":"Tamilnadu",
"COUNTRY":"IN",
"PASSWORD":"zohocorp",
"VALIDITY":"888",
"VALIDITY_TYPE":"days",
"ALG":"RSA",
"LEN":"4096",
"SIGALG":"SHA256",
"StoreType":"PKCS12"}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/createCSR?INPUT_DATA={"operation":{"Details":{"CNAME":"mytestcert", "ALT_NAMES":"test", "ORGUNIT":"zohocorp", "ORG":"manageengine", "LOCATION":"chennai", "STATE":"Tamilnadu","COUNTRY":"IN", "PASSWORD":"zohocorp", "VALIDITY":"888","VALIDITY_TYPE":"days", "ALG":"RSA", "LEN":"4096", "SIGALG":"SHA256", "StoreType":"PKCS12"}}}

{ "name": "CreateCSR", "result": { "status": "Success", "message": "CSR saved successfully" }, "totalRows": 1, "details": [ { "CSR_ID": 602 } ] }

INPUT_DATA={"operation":{"Details":{"common_name":"testcsr"}}} (optional)

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://<HostName>:7272/api/pki/restapi/getCSRList

{ "name": "GetCSRList", "result": { "status": "Success", "message": "Fetched all CSRs successfully" }, "totalRows": 1, "details": [ { "CREATED_BY": "admin", "KEYALGORITHM": "RSA", "KEYSTORE_TYPE": "JKS", "isPassword": true, "CSR_ID": 1, "CREATED_DATE": "May 15, 2020 19:51", "LOGIN_ID": 301, "KEY_STRENGTH": 2048, "DOMAIN_NAME": "testcsr", "VALIDITY": "30", "SIGNATURE_ALGORITHM": "SHA256withRSA" } ] }

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{"serverName":"pmp-w12r2-1","caName":"pmp-w12r2-1-ca","templateName":"DomainController","CSR_ID":"1"}}} 

https://<HostName>:7272/api/pki/restapi/signCSR

{"name":"SignCSR","result":{"status": "Success","message":"Successfully testdomain.com certificate signed"}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/createCertificate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{"operation":{"Details":{"CNAME":"mytestcert",
"ALT_NAMES":"test",
"ORGUNIT":"zohocorp",
"ORG":"manageengine",
"LOCATION":"chennai",
"STATE":"Tamilnadu",
"COUNTRY":"IN",
"PASSWORD":"zohocorp",
"VALIDITY":"888",
"VALIDITY_TYPE":"days",
"ALG":"RSA",
"LEN":"4096",
"SIGALG":"SHA256",
"StoreType":"PKCS12"}}}

https://<Host-Name-of-PMP-Server OR IP address> :<Port>/api/pki/restapi/createCertificate?INPUT_DATA={"operation":{"Details":{"CNAME":"mytestcert", "ALT_NAMES":"test", "ORGUNIT":"zohocorp", "ORG":"manageengine", "LOCATION":"chennai", "STATE":"Tamilnadu","COUNTRY":"IN", "PASSWORD":"zohocorp", "VALIDITY":"888", "VALIDITY_TYPE":"days", "ALG":"RSA", "LEN":"4096", "SIGALG":"SHA256", "StoreType":"PKCS12"}}}

{"name":"CreateCertificate","result":{"status":"Success","message":"Certificate saved successfully"}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserId

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserId?USERNAME=user1

{
"operation": {
"name":"get_USERID",
"result": { "status":"Success","message":"User Id for the specified username  have been fetched successfully"},"Details":{"USERID":"1"}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user?USERNAME=(username)

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP  address>:<Port>/restapi/json/v1/user?USERNAME=admin1

{"operation":{"name":"DELETE USER","result":{"status":"Success","message":"User admin1 deleted successfully"}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/addUserToUserGroup?USERNAME=(username)&USERGROUPNAME=(usergroupname)

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-ServerORIP address>:<Port>/restapi/json/v1/user/addUserToUserGroup?USERNAME=admin1&USERGROUPNAME=TestGroup

{"operation":{"name":"ADD USER TO USERGROUP","result":{"status":"Success","message":"User admin1 added to User Group TestGroup successfully"}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/lock?USERNAME=(username)

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP  address>:<Port>/restapi/json/v1/user/lock?USERNAME=apiuser

{"operation":{"name":"LOCK USER","result":{"status":"Success","message":"User account apiuser locked successfully."}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/unlock?USERNAME=(username)

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP  address>:<Port>/restapi/json/v1/user/unlock?USERNAME=apiuser

{"operation":{"name":"UNLOCK USER","result":{"status":"Success","message":"User account apiuser unlocked successfully. "}}}

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/addSSHKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{
"operation":
{
"Details":
{
"keyName":"testkey","passphrase":"passtrix"
} } }

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H 'Content-Type: multipart/form-data' -F INPUT_DATA={"operation":{"Details":{"keyName":"testkey","passphrase":"passtrix"}}} -F File=@D:/certs/keys/test1-passtrix/test1_Jul-21-2017-15_56.key https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/addSSHKey

{
"name":"addSSHKey","result":
{
"status":"SUCCESS","message":"Key imported successfully"
} }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/associateKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{
"operation":
{
"Details":
{
"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"
} } }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/associateKey?INPUT_DATA={"operation":{"Details":{"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"}}}

{
"name": "associateKey", "result":
{ "status": "Success", "message": "Key associated successfully"
} }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/dissociateKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{
"operation":
{
"Details":
{
"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"
} } }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/dissociateKey?INPUT_DATA={"operation":{"Details":{"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"}}}

{
"name": "dissociateKey", "result":
{
"status": "SUCCESS", "message": "Key dissociated successfully."
} }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={
"operation": {
"Details": {
"GROUPNAME": "CG1",
"DESCRIPTION": "description",
"PARENTGROUPID": 306,
"GROUPTYPE":"STATIC",
"POLICY": "Low",
"NoHelpDeskRetrieval": "false"
}}}

INPUT_DATA={
"operation": {
"Details": {
"GROUPNAME": "CG3",
"DESCRIPTION": "description",
"PARENTGROUPID": 3002,
"POLICY": "Low",
"NoHelpDeskRetrieval": "false",
"GROUPTYPE":"DYNAMIC",
"andor": "and",
"NoOfCriteria": 2,
"condition_1": "RESOURCENAME",
"operator_1": "CONTAINS",
"valuefield_1": "a",
"condition_2": "LOGINNAME",
"operator_2": "CONTAINS",
"valuefield_2": "e"
}}}

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup --data-urlencode "INPUT_DATA={\"operation\": {\"Details\": {\"critgroup\": \"CG1\",\"critdesc\": \"description about CG1\",\"RuleCriteria\": \"Low\",\"NoHelpDeskRetrieval\": \"false\",\"andor\": \"and\",\"NoOfCriteria\": 2,\"condition_1\": \"RESOURCENAME\",\"operator_1\": \"CONTAINS\",\"valuefield_1\": \"win\",\"condition_2\": \"LOGINNAME\",\"operator_2\":\"CONTAINS\",\"valuefield_2\": \"PMP\"} } }"

{
"operation":
{
"name":"CREATE RESOURCE GROUP",
"result":
{
"status":"Success",
"message":"Group CG1 has been added successfully."
} } }

https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/restapi/json/v1/audit?AUDITTYPE=<<Resource/User>>&STARTINDEX=&LIMIT=&DURATION=<<TODAY / YESTERDAY/ LAST_7_DAYS >>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://localhost:<Port>/restapi/json/v1/audit?AUDITTYPE=Resource&STARTINDEX=1&LIMIT=2&DURATION=YESTERDAY

{
"operation":
"name": "GET_AUDIT",
"result":
"status": "Success",
"message": "Audits fetched successfully." },
"totalRows": 2,
"Details":
"AUDITID": "3002",
"RESOURCENAME": "Not Applicable",
"ACCOUNTNAME": "N/A",
"OPERATIONTYPE": "CI/CD Settings Updated",
"OPERATEDBY": "admin",
"IPADDRESS": "localhost",
"USERNAME": "N/A",
"LASTACCESSEDTIME": "2019-01-03 14:51:06.666",
"REASON": "Jenkins Authtoken Modified.",
"NAME": "N/A",
"CLIENT": "Web Client"
},
"AUDITID": "2113",
"RESOURCENAME": "test",
"ACCOUNTNAME": "test",
"OPERATIONTYPE": "Password Verification Failed",
"OPERATEDBY": "System",
"IPADDRESS": "localhost",
"USERNAME": "N/A",
"LASTACCESSEDTIME": "2019-01-03 01:45:00.107",
"REASON": "PMP could not verify the password integrity.",
"NAME": "N/A",
"CLIENT": "Web Client"
} ] } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/share

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation": {"Details": {"ACCESSTYPE": "modify","USERID":"1" } } } Allowed accesstypes: view, modify, fullaccess, revoke

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/share

{ "operation": { "name": "SHARE RESOURCE","result": { "status":"Success","message":"Read and Modify permission granted to user successfully." } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/accounts/<accountid>/share

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={ "operation": { "Details": { "ACCESSTYPE":"modify","USERID":"1" } } } Allowed accesstypes: view, modify, revoke

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/11/share

{ "operation": { "name": "SHARE ACCOUNT","result": { "status":"Success","message":"View and Modify permission granted to user successfully." } } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/share

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"view","USERGROUPID":"1"}}}

Allowed accesstypes: view, modify, fullaccess, revoke

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/share

{ "operation": { "result": { "message": "Read Only permission granted to user group(s) successfully.", "status": "Success" }, "name": "SHARE RESOURCE" } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/accounts/<accountid>/share

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"view","USERGROUPID":"1"}}}

Allowed accesstypes: view, modify, fullaccess, revoke

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1/share

{ "operation": { "result": { "message": "Read Only permission granted to user group(s) successfully.", "status": "Success" }, "name": "SHARE ACCOUNT" } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserGroupId?USERGROUPNAME=<usergroupname>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserGroupId?USERGROUPNAME=<usergroupname>

{"operation":{"name":"GET_USERGROUPID","result":{"status":"Success","message":"Usergroup Id for the specified usergroup name have been fetched successfully. "},"Details":{"USERGROUPID":"1"}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/configureremotepasswordreset

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation": {"Details": {

"REMOTEMODE":"ssh|telnet", // Default value - ssh

"LINUX_SSHTELNETPORT":"22",

"LINUX_USERPROMPT":"$",

"LINUX_LANDINGSERVER":"test",

"RESOURCEIDENTIFIER":"linux | others", // Default value - linux

"WDRESOURCEID":"1",

"WDACCOUNTID":"1",

"REMOTELOGINACCOUNT":"",

"AUTHENTICATION":"passauth | keyauth", // Default value -passauth

"ELEVATIONTYPE":"su | sudo", // Default value - sudo

"ROOTACCOUNT":"root",

"LINUXROOTUSERPROMPT":"#",

"RESOURCEIDS":["301","302","601"],

"RESOURCETYPE":"Linux",

"REMOVEENTER":"true | false" // Default value - false}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/configureremotepasswordreset

{"operation":{"result":{

"message": "Password reset details configured for the matching resources.",

"status": "Success"},"Details":{

"CONFIGURATION RESULT":[{

"STATUS": "SUCCESS",

"RESOURCENAME": "pmp-os1.win.domain.com",

"RESOURCEID": "3"},{

"STATUS": "SUCCESS",

"RESOURCENAME": "DC-u16.lin.domain.com",

"RESOURCEID": "4"}]},

"name": "CONFIGURE REMOTE PASSWORD RESET"}}

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{"common_name":"testcert","serial_number":"xxxxxxxx","serverName":"testmachine"}}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deployCertificate 

{"result": {
"message": "Certificate deployment is successful.",
"status": "Success"
},
"name": "DeployCertificate",
"totalRows": 1,
"deployStatus": [
{
"server": "testmachine",
"message": "Certificate testcert of format CER and PFX deployed in testmachine successfully.",
"status": "Success"
}]}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateToUser

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userId":"301"}}}

{    "result": {

        "message": "Certificate shared successfully.",

        "status": "Success"

    },    "name": "ShareCertificate"}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateToUserGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userGroupId":"301"}}}

{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateGroupToUser

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userId":"301"}}}

{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateGroupToUserGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userGroupId":"301"}}}

{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateFromUser

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userId":"301"}}}

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateFromUserGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userGroupId":"301"}}}

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateGroupFromUser

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userId":"301"}}}

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateGroupFromUserGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userGroupId":"301"}}}

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/createCertificateGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{ "group_name":"NAME","group_description":"This is the description for the group certificate","group_mail":"pmp@zohocorporation.com","ssl_details":"301,202"}}}

{"result":{"message":"Certificate group added successfully.","status":"Success"},"name":"createCertificateGroup"}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificateGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{ "group_name":"NAME"}}}

{"result":{"message":"The certificate group is deleted successfully.","status":"Success"},"name":"deleteCertificateGroup"}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/editCertificateGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

INPUT_DATA={"operation":{"Details":{ "group_name":"NEW NAME","group_description":"This is new description for the group certificate","group_mail":"pmp1@zohocorporation.com","ssl_details":"1,2,3"}}}

{"result":{"message":"The certificate group is updated successfully.","status":"Success"},"name":"editCertificateGroup"}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/generateInstallKey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

{ "result": { "message": "Agent install key fetched successfully", "status": "Success" }, "name": "GetAgentInstallKey", "totalRows": 1, "AgentInstallKey": "20570b9e0ceaa936" }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/passwords/policies

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

{ "operation":{ "result":{ "message": "Password Policies fetched successfully", "status": "Success" }, "Details":{ "ORGANIZATION": "CHAKRIORG", "POLICIES":[ { ENFORCE MIXED CASE": "false", " PASSWORD MAX LENGTH": "8", " ENFORCE SPL CHARS": "false", " POLICYNAME": "Low", " ENFORCE NUMERALS": "false", " NO OF SPL CHARS REQUIRED": "0", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "false", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "0", " REUSE OF OLD PASSWORDS": "Don't allow last 1 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", POLICYID": "10000000000001", CHECK SEQUENCE": "false", DESCRIPTION": "Password with less strict constraints", " ENFORCE STARTING WITH AN ALPHABET": "false", " CHECK REPEATED SUBSTRING": "false", " PASSWORD CAN CONTAIN LOGINNAME": "false", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "0", " CHECK SIMILARITY OF PASSWORDS": "false", " PASSWORD VALIDITY PERIOD": "0", " NUMBER OF NUMERALS": "0", " PASSWORD MIN LENGTH": "4" }, { " ENFORCE MIXED CASE": "true", " PASSWORD MAX LENGTH": "10", " ENFORCE SPL CHARS": "false", " POLICYNAME": "Medium", " ENFORCE NUMERALS": "true", " NO OF SPL CHARS REQUIRED": "0", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "false", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 5 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", " POLICYID": "10000000000002", " CHECK SEQUENCE": "false", " DESCRIPTION": "Password with few strict constraints", " ENFORCE STARTING WITH AN ALPHABET": "true", " CHECK REPEATED SUBSTRING": "false", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "true", " NUMBER OF PASSWORDS TO CHECK FOR SIMILARITY": "1", " PASSWORD VALIDITY PERIOD": "180", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "6" }, { ENFORCE MIXED CASE": "true", " SEQUENCE LENGTH": "5", " PASSWORD MAX LENGTH": "16", " ENFORCE SPL CHARS": "true", POLICYNAME": "Strong", " ENFORCE NUMERALS": "true", " CHECK NUMERIC SEQUENCE": "true", " KEYBOARD LAYOUT": "QWERTY", " DESCRIPTION": "Password with strict constraints", " ENFORCE STARTING WITH AN ALPHABET": "true", " NUMBER OF PASSWORDS TO CHECK FOR SIMILARITY": "1", " PASSWORD VALIDITY PERIOD": "30", " DICTIONARY NAME": "Common Words", CHECK CONSECUTIVE SEQUENCE": "true", " NO OF SPL CHARS REQUIRED": "1", " DEFAULTPOLICY": "true", " CHECK DICTIONARY WORD": "true", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 10 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", " CHECK ALPHABET SEQUENCE": "true", " POLICYID": "10000000000003", " CHECK KEYBOARD SEQUENCE": "true", " CHECK OBVIOUS SUBSTITUTION": "false", " CHECK SEQUENCE": "true", " CHECK REPEATED SUBSTRING": "true", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "true", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "8" }, { " ENFORCE MIXED CASE": "true", " PASSWORD MAX LENGTH": "32", " ENFORCE SPL CHARS": "true", POLICYNAME": "Offline Password File", " ENFORCE NUMERALS": "true", " NO OF SPL CHARS REQUIRED": "1", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "false", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 10 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", " POLICYID": "10000000000004", " CHECK SEQUENCE": "false", " DESCRIPTION": "Policy for offline password access", " ENFORCE STARTING WITH AN ALPHABET": "false", " CHECK REPEATED SUBSTRING": "false", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "false", " PASSWORD VALIDITY PERIOD": "30", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "16" }, { " ENFORCE MIXED CASE": "true", " SEQUENCE LENGTH": "3", " PASSWORD MAX LENGTH": "10", " ENFORCE SPL CHARS": "false", " POLICYNAME": "test", " ENFORCE NUMERALS": "true", " CHECK NUMERIC SEQUENCE": "true", " KEYBOARD LAYOUT": "QWERTY", " DESCRIPTION": "testing", " ENFORCE STARTING WITH AN ALPHABET": "true", " NUMBER OF PASSWORDS TO CHECK FOR SIMILARITY": "1", " PASSWORD VALIDITY PERIOD": "180", " DICTIONARY NAME": "Common Words", " CHECK CONSECUTIVE SEQUENCE": "false", " NO OF SPL CHARS REQUIRED": "0", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "true", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 5 passwords", CHECK ANAGRAM OF LOGINNAME": "true", CHECK ALPHABET SEQUENCE": "true", " POLICYID": "10000000000011", " CHECK KEYBOARD SEQUENCE": "true", " CHECK OBVIOUS SUBSTITUTION": "true", " CHECK SEQUENCE": "true", " CHECK REPEATED SUBSTRING": "true", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "true", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "6" } ] }, "name": "GET PASSWORD POLICIES" } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcetypes

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

INPUT_DATA={ "operation":{ "Details":{ "RESOURCETYPE_CONTAINING":["brocade"], } } }

{ "operation":{ "result":{ "message": "Resource Types fetched successfully", "status": "Success" }, "Details":{ "RESOURCETYPES":[ { "COMMAND_SET":[ "Brocade" ], "ISSYNCSUPPORTED": "false", "CUSTOMRESOURCETYPE": "Windows", "ISCERTIFICATE": "false", "CATEGORY": "network", "SYNCTYPE": "CustomCli", "ISDEFAULT_SUPPORTED_RESOURCETYPE": "true", "OSID": "40", "RESOURCE_ATTRIBUTES":[ "DNS Name / IP Address", "Group Name", "Resource Description", "Department", "Resource URL", "Location", "Password Policy", "Resource Name" ], "ACCOUNT_ATTRIBUTES":[ "Password Policy", "Private Key", "Notes", "User Account", "User Account Password" ], "RESOURCETYPE": "Brocade", "DEFAULTRESOURCETYPE": "false" }, { "COMMAND_SET":[ "Brocade SAN Switch" ], "ISSYNCSUPPORTED": "false", "CUSTOMRESOURCETYPE": "Windows", "ISCERTIFICATE": "false", "CATEGORY": "network", "SYNCTYPE": "CustomCli", "ISDEFAULT_SUPPORTED_RESOURCETYPE": "true", "OSID": "42", "RESOURCE_ATTRIBUTES":[ "DNS Name / IP Address", "Group Name", "Resource Description", "Department", "Resource URL", "Location", "Password Policy", "Resource Name" ], "ACCOUNT_ATTRIBUTES":[ "Password Policy", "Private Key", "Notes", "User Account", "User Account Password" ], "RESOURCETYPE": "Brocade SAN Switch", "DEFAULTRESOURCETYPE": "false" }, { "COMMAND_SET":["Brocade VDX"], "ISSYNCSUPPORTED": "false", "CUSTOMRESOURCETYPE": "Windows", "ISCERTIFICATE": "false", "CATEGORY": "network", "SYNCTYPE": "CustomCli", "ISDEFAULT_SUPPORTED_RESOURCETYPE": "true", "OSID": "41", "RESOURCE_ATTRIBUTES":[ "DNS Name / IP Address", "Group Name", "Resource Description", "Department", "Resource URL", "Location", "Password Policy", "Resource Name" ], "ACCOUNT_ATTRIBUTES":[ "Password Policy", "Private Key", "Notes", "User Account", "User Account Password" ], "RESOURCETYPE": "Brocade VDX", "DEFAULTRESOURCETYPE": "false" } ], "ORGANIZATIONNAME": "MSPOrg" }, "name": "GET RESOURCE TYPES" } }

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/associateResources

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

INPUT_DATA={ "operation": {"Details": { RESOURCEIDS:[1, 2] }}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/associateResources

{ "operation": { "result": { "message":"Resource added to group successfully.","status":"Success"}, "Details": { "1": { "status":"Success"}, "2":{ "status":"Success" }}, "name":"ASSOCIATE RESOURCES" }}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/disassociateResources

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

INPUT_DATA={ "operation": {"Details": { RESOURCEIDS:[1, 2] }}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/disassociateResources

{ "operation": { "result": { "message":"Resource removed from group successfully.","status":"Success" }, "Details":{ "1":{ "status":"Success"}," 2":{ "status":"Success" }}, "name":"DISASSOCIATE RESOURCES" }}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<ResourceId>/associatedGroups

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<ResourceId>/associatedGroups

{ "operation": { "result":{ "message":"Associated groups fetched successfully","status":"Success"}, "Details":{ "ASSOCIATED GROUPS":[{ "GROUP ID":301,"GROUP NAME":"Default Group"}]}, "name":"GET ASSOCIATED GROUPS" }}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup?RESOURCEGROUPID=<resourcegroupid>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

orgName= <<org display name>>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup?RESOURCEGROUPID=<resourcegroupid>

{ "operation":{ "name":"DELETE RESOURCE GROUP","result": { "status":"Success","message":"Resource Group deleted successfully." }}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/getResourceGroupId?RESOURCEGROUPNAME=<resourcegroupname>&USERID=<userid>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/getResourceGroupId?RESOURCEGROUPNAME=<resourcegroupname>&USERID=<userid>

{ "operation":{ "name":"GET RESOURCE GROUP ID","result": { "status":"Success","message":"Resource Group Id for the specified Resource Group name have been fetched successfully."} ,"Details":{"RESOURCEGROUPID":"1" }}}

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/resetMFA?USERNAME=<username>

AUTHTOKEN=<<Authtoken_generated_from_PMP>>

USERNAME=<username>

https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/resetMFA?USERNAME=<username>

{
"operation":{
"result":{
"message": "Two Factor Authentication reset successfully",
"status": "Success"
},
"name": "Reset MFA"
}
}

https://<Host-Name-of-PMP-Server OR IPddress>:<Port>/restapi/json/v1/resourcegroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>

{
"operation": {
"result": {
"message": "Resource group list fetched successfully",
"status": "Success",
"statusCode": 20000
},
"Details": [
{
"resourceGroupDescription": "Group of Windows resources",
"accessType": "modify",
"resourceGroupName": "a2",
"isOwner": "false",
"resourceGroupType": "dynamic",
"resourceGroupId": "1201",
"timeCreated": "2023-02-24 18:01:24.378",
"subGroupOf": "1", //Parent ID
"ownerId": "1"
},
{
"resourceGroupDescription": "All the resources created by me",
"accessType": "fullaccess",
"resourceGroupName": "Default Group",
"isOwner": "true",
"resourceGroupType": "static",
"resourceGroupId": "301",
"timeCreated": "2023-02-14 14:55:22.998",
"subGroupOf": "",
"ownerId": "301"
},
{
"resourceGroupDescription": "Group of Linux resources",
"accessType": "fullaccess",
"resourceGroupName": "st1",
"isOwner": "false",
"resourceGroupType": "static",
"resourceGroupId": "1202",
"timeCreated": "2023-02-24 18:02:10.251",
"subGroupOf": "2",
"ownerId": "1"
},
{
"resourceGroupDescription": "Group of Windows Domain resources",
"accessType": "fullaccess",
"resourceGroupName": "static",
"isOwner": "false",
"resourceGroupType": "static",
"resourceGroupId": "901",
"timeCreated": "2023-02-24 16:08:26.262",
"subGroupOf": "3",
"ownerId": "1"
}
],
"name": "GET_RESOURCE_GROUPS",
"totalRows": 4
}
}

https://<Host-Name-of-PMP-Server OR IPddress>:<Port>/restapi/json/v1/passwords/validate

AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>

INPUT_DATA={
"operation":{
"details":{
"password": "Test@123",
// Either passwordPolicy or passwordPolicyId should be given
"passwordPolicy": "Strong",
"passwordPolicyId":"1"
}
}
}

{
"operation": {
"result": {
"message": "Valid",
"status": "Success",
"statusCode": 20000
},
"name": "VALIDATE_PASSWORD"
}
}

https://<Host-Name-of-PMP-Server OR IPddress>:<Port>/restapi/json/v1/userGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>

INPUT_DATA={
"operation": {
"details": {
"userGroupIds": [1231,24553]
}
}
}

{
"operation": {
"result": {
"message": "User group(s) has been deleted successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": {
"1231": {
"message": "Invalid User group Id.",
"status": "Failed",
"statusCode": 46000
},
"24553": {
"message": "User group(s) has been deleted successfully.",
"status": "Success",
"statusCode": 20000
}
},
"name": "DELETE_USERGROUP"
}
}

https://<Host-Name-of-PMP-Server OR IPddress>:<Port>/restapi/json/v1/agents/agentkey

AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>

Provide INPUT_DATA only for generating a new agent key.

INPUT_DATA={
"operation": {
"details": {
"generateAgentKey": "true",
"validityPeriod":3 // Provide this param to use the agent key in multiple installations for a stipulated time (In hours).
}
}
}

{
"operation": {
"result": {
"message": "Fetched Agent Key successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": {
"agentKey": "66f835703f814e2e",
"agentKeyEndTime": "09/02/2023 01:03:31"
},
"operationName": "Fetch Agent Key"
}
}

https://<Host-Name-of-PMP-Server OR IPddress>:<Port>/restapi/json/v1/server/getHighAvailabilityStatus

AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>

{
"operation": {
"name": "Get HA Status",
"result": {
"status": "Success",
"message": "HA Status fetched successfully"
"statusCode":20000
},
"Details":{
"haStatus":"active",
"isPrimaryServer":"true",
"primaryServer":"master.server.com",
"primaryServerStatus":"active",
"secondaryServer":"slave.server.com",
"secondaryServerStatus":"active",
}
}
}

https://<Host-Name-of-PMP-Server OR IPddress>:<Port>/restapi/json/v1/user/removeUserFromUserGroup

AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>

INPUT_DATA={
"operation":{
"Details":{
"USERIDS":[1,2],
"USERGROUPIDS":[2,3]
}
}
}

{
"operation": {
"result": {
"message": "Users removed from User Group Successfully",
"status": "Success"
},
"Details": {
"RESULT": [
{
"USERID": "1",
"message": "User Removed Successfully",
"USERGROUPID": "2",
"status": "Success"
},
{
"USERID": "1",
"message": "User does not exist in the User Group",
"USERGROUPID": "3",
"status": "Failed"
},
{
"USERID": "2",
"message": "User does not exist in the User Group",
"USERGROUPID": "2",
"status": "Failed"
},
{
"USERID": "2",
"message": "User Removed Successfully",
"USERGROUPID": "3",
"status": "Success"
}
]
},
"name": "REMOVE USER FROM USER_GROUP"
}
}