Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Assemblyline 4 - API and Socket IO server

This component provides the User Interface as well as the different APIs and socketio endpoints for the Assemblyline 4 framework.

Components

APIs

Assemblyline 4 provides a large set of API that can provide you with all the same information you will find in it's UI and even more. The list of APIs and their functionality is described in the help section of the UI.

All APIs in Assemblyline output their result in the same manner for consistency:

{
   "api_response": {},            //Actual response from the API
   "api_error_message": "",       //Error message if it is an error response
   "api_server_version": "4.0.0"  //Assemblyline version and version of the different component
   "api_status_code": 200         //Status code of the response
}

NOTE: All response codes return this output layout

SocketIO endpoints

Assemblyline 4 also provide a list of SocketIO endpoints to get information about the system live. The endpoints will provide authenticated access to many Redis broadcast queues. It is a way for the system to notify user of changes and health of the system without having them to query for that information.

The following queues can be listen on:

  • Alerts created
  • Submissions ingested
  • Health of the system
  • State of a given running submission

Metadata

Release files for assemblyline-ui 4.2.1.dev141

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for assemblyline-ui 4.2.1.dev141
File Interpreter ABI Platform
assemblyline_ui-4.2.1.dev141-py3-none-any.whl Python 3 none any Details

Release files / assemblyline_ui-4.2.1.dev141-py3-none-any.whl

Download URL assemblyline_ui-4.2.1.dev141-py3-none-any.whl
Size 128.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a615800beced163d0700e251f5be8a0128108f94148f118b8e124d1cf19bc7dd
BLAKE2b-256 checksum
How to use checksums
661abbca053c9312656926a4aa606a562e2c1c4ae7a1fa934abb3d92bc91e96b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.10

Security for assemblyline-ui 4.2.1.dev141

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page