PIpicussecurity
Apv

# Create Simulation

Changed on

Creates a Gray-Box, Red-Team, or Black-Box simulation. GRAY_BOX/BLACK_BOX are agent-based (agent_id required; initial_machine additionally required for GRAY_BOX) and can be launched instantly or on a schedule. RED_TEAM is stager-based (stager_id required instead of agent_id) and only launches instantly - initial_machine and schedule are both rejected if sent.

post/v1/apv/simulations

Request

Request body

agent_idinteger

Required for GRAY_BOX/BLACK_BOX (agent-based). Not supported for RED_TEAM - the request is rejected if this is non-zero (use stager_id instead).

descriptionstring
namestring
simulation_typestring
stager_idstring

Required for RED_TEAM (use this instead of agent_id) - which stager to generate. Ignored for agent-based simulations (GRAY_BOX/BLACK_BOX).

Example request

{
  "agent_id": 101,
  "description": "Quarterly lateral movement validation",
  "initial_machine": {
    "domain_controller_ip": "10.0.0.6",
    "hostname": "10.0.0.6",
    "password": "password",
    "user_domain": "USER.DOMAIN",
    "username": "username"
  },
  "name": "Q3 Gray-Box Simulation",
  "policy": {
    "assessment_duration": 4320,
    "domain_name": "corp.local",
    "enable_opc": true,
    "exclusion": [
      "10.0.0.5"
    ],
    "inclusion": [
      "10.0.0.0/24"
    ]
  },
  "schedule": {
    "frequency": "WEEKLY",
    "frequency_interval": 1,
    "start_time": 1655984364000
  },
  "simulation_type": "GRAY_BOX",
  "stager_id": "HONEYBADGER"
}

Response

CreateSimulationResponseSwagger

run_uuidstring
simulation_uuidstring

Example response

{
  "run_uuid": "r9y8x7w6-0000-0000-0000-000000000002",
  "simulation_uuid": "a1b2c3d4-0000-0000-0000-000000000001"
}

Changes