# List APV Simulations

Lists Attack Path Validation simulations for the account. Used to discover the
simulation_uuid/run_uuid pairs needed by the run-scoped endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

About

List APV Simulations endpoint returns the Attack Path Validation simulations of the account with each simulation's name, type, status, creator, creation time and last run time, together with the simulation UUID and the UUID of its latest run.

Use the returned simulation_uuid / run_uuid pairs with the run-scoped endpoints such as Run Summary, Run Status, Exposures, Attack Path and the report endpoints.

Results can be filtered by simulation name (name_like, partial match), status and simulation_type. Multiple status or type values can be sent comma-separated. Results are paginated with limit and offset.

Example

List the completed Gray-Box simulations whose name contains "Q3".

curl --request GET \
     --url 'https://api.picussecurity.com/v1/apv/simulations?name_like=Q3&status=COMPLETED&simulation_type=GRAY_BOX&limit=20&offset=0' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer access_token'
{
  "pages": {
    "limit": 20,
    "offset": 0,
    "total_count": 1
  },
  "simulations": [
    {
      "created_at": 1751360400000,
      "created_by": "[email protected]",
      "last_run_time": 1751362320000,
      "name": "Q3 Gray-Box Simulation",
      "run_uuid": "{run_uuid}",
      "simulation_type": "GRAY_BOX",
      "simulation_uuid": "{simulation_uuid}",
      "status": "COMPLETED"
    }
  ]
}
Query Params
int64
int64
string

Filter by simulation name (partial match)

status
array of strings

Filter by status (comma-separated): WAITING | INITIALIZING | RUNNING | POSTPROCESSING |
COMPLETED | STOPPED | FAILED | ACHIEVED | WAITING FOR THE FIRST RUN | NOT STARTED

status
simulation_type
array of strings

Filter by simulation type (comma-separated): GRAY_BOX | RED_TEAM | BLACK_BOX | DOMAIN_ADMIN |
RANSOMWARE

simulation_type
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json