# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/CybercentreCanada/assemblyline-ui/",
"name": "assemblyline-ui",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "assemblyline automated malware analysis gc canada cse-cst cse cst cyber cccs",
"author": "CCCS Assemblyline development team",
"author_email": "assemblyline@cyber.gc.ca",
"download_url": null,
"platform": null,
"description": "# Assemblyline 4 - API and Socket IO server\n\nThis component provides the User Interface as well as the different APIs and socketio endpoints for the Assemblyline 4 framework.\n\n### Components\n\n#### APIs\n\nAssemblyline 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. \n\nAll APIs in Assemblyline output their result in the same manner for consistency:\n\n {\n \"api_response\": {}, //Actual response from the API\n \"api_error_message\": \"\", //Error message if it is an error response\n \"api_server_version\": \"4.0.0\" //Assemblyline version and version of the different component\n \"api_status_code\": 200 //Status code of the response\n }\n\n **NOTE**: All response codes return this output layout\n\n#### SocketIO endpoints\n\nAssemblyline 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.\n\nThe following queues can be listen on:\n\n* Alerts created\n* Submissions ingested\n* Health of the system\n* State of a given running submission\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Assemblyline 4 - API and Socket IO server",
"version": "4.5.0.19",
"project_urls": {
"Homepage": "https://github.com/CybercentreCanada/assemblyline-ui/"
},
"split_keywords": [
"assemblyline",
"automated",
"malware",
"analysis",
"gc",
"canada",
"cse-cst",
"cse",
"cst",
"cyber",
"cccs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f68279a2308bac8e912f304a361b54b61b7bd2216a06b653171fa76662ae4c4",
"md5": "74b321ede8f069d5dbb93b5208e22504",
"sha256": "062334c22ae5e109e9a15a0591f4c40b1f967e8e5b8e8b4cdadf65ff23bdf1b1"
},
"downloads": -1,
"filename": "assemblyline_ui-4.5.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74b321ede8f069d5dbb93b5208e22504",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 174991,
"upload_time": "2024-04-23T19:39:10",
"upload_time_iso_8601": "2024-04-23T19:39:10.482673Z",
"url": "https://files.pythonhosted.org/packages/3f/68/279a2308bac8e912f304a361b54b61b7bd2216a06b653171fa76662ae4c4/assemblyline_ui-4.5.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 19:39:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CybercentreCanada",
"github_project": "assemblyline-ui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "assemblyline-ui"
}
JSON
