CyberArk REST API

All available requests in CyberArk Privileged Account Security Web Services

DUE TO INTERNAL CYBERARK POLICY, AS OF 2/18/2024 POSTMAN WILL NO LONGER BE USED DUE TO SYNCHRONIZATION OF DATA TO THE CLOUD. NO FURTHER UPDATES TO THIS COLLECTION WILL OCCUR. IF YOU WOULD LIKE TO CONTINUE SUPPORT FOR POSTMAN, FEEL FREE TO FORK THIS REPOSITORY AND CONTINUE DEVELOPMENT.

THIS IS UNOFFICIAL DOCUMENTATION

Happy automating!

Getting Started Guide

Getting Started with REST Using Postman (PDF)

Community Tools

psPAS - PowerShell Module for CyberArk's REST API
CredentialRetriever - PowerShell Module for CyberArk's Application Access Manager (AAM)
pyAIM - Python Client Library for CyberArk's Application Access Manager (AAM)

Code Examples

YouTube Videos Playlist

CyberArk Videos Playlist Curated by InfamousJoeG

Maintainer

Joe Garcia

Buy me a coffee

Status Codes

Status Name	Status Code	Status Description
Success	200	The request succeeded. The actual response will depend on the request method used.
Created	201	The request was fulfilled and resulted in a new resource being created.
Bad Request	400	The request could not be understood by the server due to incorrect syntax.
Unauthorized	401	The request requires user authentication.
Forbidden	403	The server received and understood the request, but will not fulfill it. Authorization will not help and the request MUST NOT be repeated.
Not Found	404	The server did not find anything that matches the Request-URI. No indication is given of whether the condition is temporary or permanent.
Conflict	409	The request could not be completed due to a conflict with the current state of the resource.
Internal Server Error	500	The server encountered an unexpected condition which prevented it from fulfilling the request.

NOTE: If you are having issues with DEL or PUT methods, make sure that your Password Vault Web Access (PVWA) Server's IIS instance does not include WebDav Publishing. This will cause known issues.