ETethiack
pentests
pentests

Update a pentest launch

Update a launch's mutable fields.

Restricted to machine callers operating within the pentest's scope.

Args: pentest_id (int): The parent pentest, resolved and access-checked by the router's gate. launch_id (int): Identifier of the launch within the pentest. body (UpdateLaunchRequest): Fields to update on the launch. db (AsyncSession): Request-scoped database session. context (ActiveContext): Resolved caller identity and scope.

Returns: LaunchResponse: The updated launch.

patch/v1/pentests/{pentest_slug}/launches/{launch_id}

Request

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

Path parameters

launch_idinteger required
pentest_slugstring required

Request body

status'pending' | 'in_progress' | 'finished' | 'error' | 'canceled'

Human-readable launch execution status.

Maps to StatusEnum integer values stored in the database.

error_infostring nullable

Error message to record.

start_timestring date-time nullable

Execution start time.

finish_timestring date-time nullable

Execution end time.

Response

Successful Response

idinteger required

Launch ID.

pentest_idinteger required

Parent pentest ID.

machine_user_idstring uuid required

Owning machine user ID.

modeinteger nullable

Artiacker mode code.

status'pending' | 'in_progress' | 'finished' | 'error' | 'canceled' required

Human-readable launch execution status.

Maps to StatusEnum integer values stored in the database.

error_infostring nullable

Error message when the launch failed.

sub_job_idinteger nullable

Linked scan_sub_jobs row.

start_timestring date-time nullable

Execution start time.

finish_timestring date-time nullable

Execution end time.

createdstring date-time required

Creation timestamp.

Changes

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