Scope of The Picus API
Welcome to The Picus Rest API Documentation!
Picus Rest API enables you to access Picus Platform functionality externally in accordance with your Picus licensing. So that you can access Picus, create and run simulations, see results from anywhere.
We have grouped our endpoints into the following sections:
-
Simulations: You can reach the Simulation List and the details.
-
Create Simulation and run a simulation again Simulate Now. You can also Update, Delete and Cancel a simulation with the provided endpoints.
-
Simulation Results: Access Simulation Run Results, Threat and Action Details, and Detection Analytics Results (including Alert/Log Details). Additionally, you can access the results of MITRE ATT&CK and Unified Kill Chain framework mappings.
We have also prepared an endpoint for you to directly access the Latest Simulation Run. -
Threat List: Get Threat Library, Threat Details and Action Details.
-
Get information about Dynamic & Static Threat Templates with Threat Templates and Template Detail endpoints. Use Create Templates endpoint to create a Dynamic or Static Template.
-
Get the list of your agents with Agent List endpoint. Also learn the details of how your Simulation agents are used with the Agent Detail endpoint.
-
Learn the status of your Integrations and Integration agents.
-
Mitigations: Access Vendor based Prevention Suggestions and Signature List.
Updated over 2 years ago