Skip to main content
POST
Check that Hacktron can sign in to each login target, which it must before the pentest starts
Checks whether Hacktron can sign in to each of the draft’s login_targets using the saved login instructions. Every login check must pass before the pentest can start.
Scope required: write. Role: member or above.
  • A successful check is valid for one hour. Start the pentest within that time or run the check again.
  • Hacktron skips checks that are already running or passed within the last hour, unless the site or login instructions have changed.
  • Set wait_seconds to wait up to 50 seconds for the checks. Without it, the endpoint returns while checks are pending. You can call again with wait_seconds to wait for the results. Each call retries failed logins, so update incorrect instructions before calling again.
Each entry in login_targets includes a login_check status: pending or running while the check is in progress, succeeded after a successful sign-in, or failed if Hacktron couldn’t sign in. A failed check includes a failure_reason without login details. Correct the instructions with Update pentest draft, then run the check again.

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Query Parameters

wait_seconds
integer
default:0

Wait up to this many seconds for the work to finish before answering

Required range: 0 <= x <= 50

Response

scan_id
string<uuid>
required

Stable pentest id; task_id changes when it starts

status
enum<string>
required
Available options:
pending,
running,
completed,
failed,
stopped,
cancelled,
skipped,
pending_verification,
pending_triage,
draft,
estimating,
estimated
repos
object[]
required
target_urls
string[]
required
login_targets
object[]
required
custom_context
string | null
required
application_id
string<uuid> | null
required
cost_estimation_id
string<uuid> | null
required
triage_enabled
boolean | null
required
credits_used
number | null
required