Pentests Schedule a new pentest
POST
/api/pentests/schedule

Authentication

Bearer Token (BearerAuth)

Headers

X-Target-Serverstringrequired

Internal IP and port of the pt-agent instance (e.g. 10.10.0.26:9741)


Request Body

Required

targetsobject[]required

stylestringrequired

exploitbooleanrequired

lightweightbooleanrequired

playbookstring

memorystring[]

inline_memorystring[]

Example:

{
  "targets": [
    {
      "target": "string",
      "scope": "string",
      "type": "string",
      "credentials": "string"
    }
  ],
  "style": "string",
  "exploit": true,
  "lightweight": true,
  "playbook": "string",
  "memory": [
    "string"
  ],
  "inline_memory": [
    "string"
  ]
}

Responses

200
Pentest scheduled

Response Fields:

  • pentest_id (string)

Example:

{
  "pentest_id": "string"
}