Engine Configuration Options

When adding or editing an engine, there are many configuration options and this page will review these.

Name

Give your Engine a unique name. Remember that this name you choose will be visible on the Engines page.

Note: If you use the copyrighted name of a publicly available product, during the Verification process PolySwarm will require you to provide proof that you have rights to use that name.

Webhook

If you haven’t already created a webhook in your Account Settings, you can create one here. However, it is best practice to create the webhook in your Account Settings first, so that you can test and verify it before associating it with an Engine. The Rate Limit on the webhook determines the maximum number of artifacts your Engine will accept per day.

Website

Provide the URL of a website that has additional details about your Engine or your company.

Description

PolySwarm recommends that you provide a description for your Engine. Think of it like a brief marketing description of your Engine and its capabilities. 1-2 sentences using 200 words or less is usually sufficient.

Max file size

Define the max size of artifacts that your engine can process. The PolySwarm Marketplace has an internal max file size, but this allows you to define your upper limit below the Marketplace limit.

Tags

• All Microengines have the “microengine” tag.
• All Arbiters have the "arbiter" tag.
• All Engines that support “file” artifacts will have the “file” tag, and for “url” artifacts will have the “url” tag.

Other than those required Tags, you are free to associate other Tags with your Engine.

Most Engine owners select tags that are related to the types of files the Engine processes or types of technologies implemented in the Engine.

Click the “Down Arrow” to see the list of available Tags.

Supported mimetypes

This is where you can define which types of files your Engine can process. If you leave this blank, the Marketplace will assume your Engine can process all files. Click the “Down Arrow” to see a list of available Mimetypes.

Table of Mimetypes by Category

This table should help you select which Mimetypes are appropriate for your Engine. We've grouped the available mimetypes into commonly referenced Categories.

Category	Mimetype
android	application/vnd.android.package-archive application/java-archive application/zip application/octet-stream
archives	application/java-archive application/x-tar application/zip application/x-compressed-zip application/gzip application/vnd.rar application/x-bzip2 application/x-xz application/octet-stream application/x-7z-compressed application/x-rar-compressed application/x-lha application/x-ace-compressed
disk image	application/x-cd-image application/x-iso9660-image application/x-daa
elf	application/x-executable application/x-elf
flash	application/x-shockwave-flash
font	application/vnd.ms-fontobject application/vnd.oasis.opendocument.text font/otf font/ttf font/woff font/woff2 font/collection font/sfnt
image/video	image/tiff video/mp4 image/png image/bmp image/svg+xml image/jpeg image/webp image/gif
java	application/x-java-applet
linux	elf + application/x-cpio application/x-rpm application/x-dpkg application/octet-stream application/x-sharedlib
mach-o	application/x-mach-binary application/octet-stream
office (abiword)	application/x-abiword
office (etc)	text/calendar
office (ms)	application/msword application/vnd.ms-excel application/vnd.ms-excel.addin.macroEnabled.12 application/vnd.ms-excel.sheet.binary.macroEnabled.12 application/vnd.ms-excel.sheet.macroEnabled.12 application/vnd.ms-excel.template.macroEnabled.12 application/vnd.ms-powerpoint application/vnd.ms-powerpoint.addin.macroEnabled.12 application/vnd.ms-powerpoint.presentation.macroEnabled.12 application/vnd.ms-powerpoint.slideshow.macroEnabled.12 application/vnd.ms-word.document.macroEnabled.12 application/vnd.ms-word.template.macroEnabled.12 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet application/vnd.openxmlformats-officedocument.spreadsheetml.template application/vnd.openxmlformats-officedocument.wordprocessingml.document application/vnd.openxmlformats-officedocument.wordprocessingml.template application/vnd.ms-office application/x-ms-shortcut application/vnd.ms-powerpoint.template.macroEnabled.12 application/x-mspublisher application/CDFV2-corrupt application/CDFV2-encrypted
office (open)	application/vnd.oasis.opendocument.chart-template application/vnd.oasis.opendocument.chart application/vnd.oasis.opendocument.database application/vnd.oasis.opendocument.formula application/vnd.oasis.opendocument.graphics-template application/vnd.oasis.opendocument.graphics application/vnd.oasis.opendocument.image-template application/vnd.oasis.opendocument.image application/vnd.oasis.opendocument.presentation-template application/vnd.oasis.opendocument.presentation application/vnd.oasis.opendocument.spreadsheet-template application/vnd.oasis.opendocument.spreadsheet application/vnd.oasis.opendocument.text-master application/vnd.oasis.opendocument.text-template application/vnd.oasis.opendocument.text-web application/vnd.oasis.opendocument.text application/vnd.openofficeorg.extension application/vnd.openxmlformats-officedocument.presentationml.presentation application/vnd.openxmlformats-officedocument.presentationml.slideshow application/vnd.openxmlformats-officedocument.presentationml.template
osx	mach-o + application/octet-stream
pdf	application/pdf text/plain application/octet-stream
pe	application/x-dosexec application/x-msdownload application/x-msi application/vnd.ms-msi application/vnd.microsoft.portable-executable application/vnd.ms-cab-compressed application/vnd.ms-access application/x-msinstaller
rtf	application/rtf text/plain text/rtf
text & script	application/x-httpd-php application/javascript application/json application/x-sh application/x-csh text/html text/plain text/x-python text/xml text/plain application/vnd.coffeescript application/x-vbe application/hta application/PowerShell application/xml text/javascript application/x-perl message/rfc822 text/scriptlet application/vnd.ms-htmlhelp text/vbscript
windows	pe + application/octet-stream image/vnd.microsoft.icon text/plain

Note: The mimetype application/octet-stream is a generic mimetype for a file that has binary content. Sometimes the mimetype detection cannot correctly select the exact mimetype of a file and will default to application/octet-stream. So, it is generally a good practice to select it if your Engine processes binary files.

Engine type

The only option right now is “Engine”. For Arbiters, PolySwarm will manually convert an Engine to an Arbiter during the on-boarding process.

Supported Artifact Types

Select “file” if your Engine can process files. Select “url” if your Engine processes URLs, domains, and IP addresses.