Skip to main content
POST
Analyze firmware binary for security

Authorizations

X-Customer-Key
string
header
required

Customer API key for authentication

Body

name
string
required

Name for the firmware analysis

Example:

"iot-device-firmware"

content_base64
string
required

Base64-encoded firmware binary

Example:

"f0VMRgIBAQAAAAAAAAAAAA=="

file_name
string

Original filename (optional)

Example:

"firmware-v2.6.11.bin"

Response

Firmware analysis completed

id
string<uuid>
required
name
string
required

Firmware name

detected_format
enum<string>
required

Detected binary format

Available options:
elf,
pe,
mach_o,
wasm,
raw
strings
string[]
required

Extracted ASCII strings (max 200)

security_features
enum<string>[]
required

Detected security features

Available options:
nx,
aslr,
stack_canary,
cfi,
fortify,
pie,
relro,
signed
findings
string[]
required

Security findings with severity (CRITICAL, HIGH, MED, LOW, INFO)

Example:
architecture
string

CPU architecture

Example:

"x86_64"

entry_point
string

Entry point address

Example:

"0x401000"

cfg_mermaid
string

Control Flow Graph in Mermaid format (if available)

mappings
object[]

Mappings to compliance frameworks

pfr_assessment
object

NIST SP 800-193 Platform Firmware Resilience assessment

artifacts
object[]