ETethiack
pentests
pentests

Create a machine pentest

Create a machine pentest, in draft.

Conflicts (HTTP 409) when the organization is already running as many continuous pentests as its subscription meters. The pentest is left in draft, as the pre-rename endpoint left it: POST {slug}/start is what puts it to work.

Args: body (CreateMachinePentestRequest): Owning organization and the seeding options. db (AsyncSession): Request-scoped database session. context (ActiveContext): Resolved caller identity and scope.

Returns: SuccessResponse: The pre-rename create envelope, carrying the new pentest's slug as id — that is what the endpoint answered, and a client stores what it is given.

post/v1/pentests/

Request

  • Base URL
    https://api.ethiack.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Request body

organization_idinteger nullable

Organization that owns the pentest. Required for partners; organization callers may omit it.

add_assetsboolean

Add the organization's existing assets to scope, including verified domains as wildcard assets (every domain, when the organization's integrator partner vouches for it).

launch_reconboolean

Launch a recon for the pentest. Adds those domains as wildcard assets if they are not already there.

end_datestring date-time nullable

End date in ISO 8601 format, timezone-aware and in the future. Defaults to the organization's subscription end, which it may not exceed.

namestring nullable

Display name. Generated from the slug when omitted.

Response

Successful Response

codeinteger required
descriptionstring required
successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.