Request archive upload

1 min

, , , , ,

Returns a signed URL for uploading a .zip, .7z, or .tar.gz source archive, for code that isn’t in a connected repository. You need the member role or above.

Call this endpoint with the archive’s file_name.
PUT the file to upload_url, with the Content-Type header set to the returned content_type.
Add { "source": "upload", "archive_id": "<id>" } to repos when you create a pentest draft with POST /pentests.

To pentest part of the archive, set include_paths or exclude_paths on its entry in repos. You can use the same uploaded archive.

Note

Some self-hosted deployments return 400 because they don’t support API uploads. In that case, upload the archive through the Hacktron web app.

Request

POST /archives/uploads

Send an API key with the write scope in the X-Api-Key header.

curl -X POST "https://api.hacktron.ai/v1/archives/uploads" \
  -H "X-Api-Key: $HACKTRON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file_name": "my-project.zip"
}'

{
  "id": "string",
  "upload_url": "string",
  "content_type": "application/zip"
}

Body

A required application/json body.

Field	Description
`file_name` string, required	Original filename (e.g. "my-project.zip").
`name` string	Display name (defaults to filename).

Responses

201 Created

Field	Description
`id` string, required	Archive ID.
`upload_url` string, required	Signed GCS upload URL (PUT).
`content_type` string, required	Content-Type to use in the PUT request.