---
id: assemblyline-ui
version: "4.7.4.9"
license: MIT
license_treatment: permissive
maintenance: active
---

# assemblyline-ui — Assemblyline 4 - API and Socket IO server

License: permissive · Maintenance: active · Downloads: 73.9K/mo

## What it is and what it does

Assemblyline-ui is the web interface and API server for Assemblyline 4, a malware analysis framework. It exposes REST APIs and SocketIO WebSocket endpoints that provide access to submission results, alerts, system health, and live submission state. The package bundles a Flask-based web UI and server infrastructure, designed to be deployed as a containerized service component rather than embedded in other applications.

The package depends on 15 runtime libraries covering web serving (Flask, Werkzeug, Gunicorn, Gevent), authentication (python-ldap, python3-saml, Authlib, fido2, PyJWT), and XML/QR handling (lxml, xmlsec, pyqrcode). It is actively maintained, with a release from 2 days ago and recent commits, and carries no known security vulnerabilities.

Use it for:

- Deploy as the primary web interface and API gateway for an Assemblyline 4 malware analysis cluster.
- Integrate with external security tools via REST APIs to query submission results and alert status.
- Monitor live system health and submission progress using SocketIO WebSocket endpoints.
- Implement custom authentication (LDAP, SAML, FIDO2) for enterprise security analysis platforms.
- Build dashboards and reporting tools that consume Assemblyline APIs for threat intelligence workflows.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides REST APIs, WebSocket endpoints, and a web UI for the Assemblyline 4 malware analysis framework, enabling programmatic and interactive access to submission results, alerts, and system health.

Yes, if you are deploying or extending Assemblyline 4. The package is actively maintained, carries no known vulnerabilities, and has low install friction. However, it is a service component designed for containerized deployment, not a general-purpose library—install it only if you are running an Assemblyline instance or integrating with one via its APIs.

## Install

pip install assemblyline-ui
uv add assemblyline-ui
poetry add assemblyline-ui

## Installing assemblyline-ui

Before you install: Active maintenance with a release 2 days old and recent commits. Low install friction with a pure Python wheel. Depends on 15 runtime packages including Flask, Werkzeug, and authentication libraries (python-ldap, python3-saml, Authlib, fido2), which are standard but add complexity to deployment.

License in practice: MIT license permits commercial and private use with minimal restrictions; you may use, modify, and distribute this package freely provided you include the license notice.

Quickstart:

pip install assemblyline-ui

from assemblyline_ui import app
# The package provides Flask/Gunicorn-based server; typically deployed via Docker or direct WSGI runner
gunicorn assemblyline_ui:app

Requires assemblyline and assemblyline-core packages installed; designed for deployment as a service component rather than library import, typically run in Docker or behind a reverse proxy.

Verify before relying:

- Whether the package can be used as a standalone library or is intended only as a deployed service component.
- Specific Python version requirements (classifiers list 3.7–3.11 but requires_python is unspecified).
- Configuration and environment variable requirements for authentication backends (LDAP, SAML, FIDO2).

## Package facts

- License: MIT (permissive)
- Python support: unspecified
- Install friction: low
- Maintenance: active
- Downloads: 73.9K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

malware analysis api server, assemblyline ui interface, socketio real-time alerts, security analysis dashboard, automated threat detection api, submission tracking interface, security framework ui, live system monitoring endpoints, malware-analysis, security-framework, api-server

[View on SkillFed](https://skillfed.io/packages/assemblyline-ui) · [View on PyPI](https://pypi.org/project/assemblyline-ui/)