Inputs

💡 Click on the Input Name for more Details.

Input Name	Default Value	Description of the Input Value
vt_api_key	Required	VirusTotal API Key
file_globs	-	File Globs to Process
rate_limit	4	API Calls Per Minute
release_id	-	Release ID to Process
sha256	false	Calculate File SHA256
summary	true	Add Summary to Job
github_token	github.token	For use with a PAT
update_release	true	Update the
release_heading	see below	Release Notes Heading
collapsed	false	Show Links Collapsed.
file_name	name	File Name Display: [name, id]

For more details on inputs, see the VirusTotal API documentation.

See the Examples section for more options.

Details

vt_api_key Required

Get your API key from: https://www.virustotal.com/gui/my-apikey

file_globs

If provided, will process matching files instead of release assets.
For glob pattern, see examples and the docs.

rate_limit

Rate limit for file uploads. Set to 0 to disable if you know what you are doing.

Default: 4

release_id

If provided, will process the corresponding release. The release ID can be generated from a previous step. By providing a release ID, this action does not need to run on a release event to process a release.

sha256

The SHA256 hash is not returned by the API; however, can be optionally calculated for additional overhead. If enabled this will calculate the file's SHA256 hash, and include it in the output.

Default: false

summary

Will add result details to the job summary in the workflow.

View Job Summary Example

File	ID
README.md	YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw==
.gitignore	ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw==

Outputs

[
  {
    "id": "YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw==",
    "name": "README.md",
    "link": "https://www.virustotal.com/gui/file-analysis/YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw=="
  },
  {
    "id": "ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw==",
    "name": ".gitignore",
    "link": "https://www.virustotal.com/gui/file-analysis/ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw=="
  }
]

README.md/YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw==
.gitignore/ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw==

Config

files: ["README.md",".gitignore"]
rate: 4
update: true
heading: "🛡️ **VirusTotal Results:**"
summary: true

To view a workflow run, click on a recent Test job (requires login).

Default: true

github_token

The ${{ github.token }} / ${{ secrets.GITHUB_TOKEN }} is automatically passed, there is no need to manually pass these!

This is only available to allow users to pass a different token they have created and defined in their secrets for explicit use with a PAT.

Default: ${{ github.token }}

Release Notes

If run on a release event, the Release Notes are automatically updated with the results unless you set update_release to false. You can customize the heading or remove it by specifying an empty string.

Example Release Notes.

🛡️ VirusTotal Results:

• install-linux.deb
• install-macos.pkg
• install-win.exe

update_release

If triggered from a release workflow, will update the release notes and append the results.

Default: true

release_heading

Customize the Release Notes Heading.

Default: 🛡️ **VirusTotal Results:**

collapsed Experimental

Set to true to collapse the result links by default.

Default: false

file_name

Customize the Release Notes File Name Display. This can be one of name, or id.

Default: name