Server Web API
If authentication fails, the web server will respond with a 404 page by default.
Auth
POST {endpoint}/login
Authenticate and receive a JWT
Request (JSON)
usernamestring - operator loginpasswordstring - operator password
Response (JSON)
access_tokenstring - JWT access tokenrefresh_tokenstring - JWT refresh token
POST {endpoint}/refresh
Update JWT access token
Request (JSON)
Header Authorization: Bearer <refresh_token>
Response (JSON)
access_tokenstring - JWT access token
POST {endpoint}/sync
Start synchronizing data with the client via WebSocket
Request (JSON)
Header Authorization: Bearer <access_token>
Response
POST {endpoint}/otp/generate
Generate OTP
Request (JSON)
Header Authorization: Bearer <access_token>
typestring - object type: "download" or "tmp_upload"idstring - object ID
Response (JSON)
okbool - statusmessagestring - OTP or error text
Chat
POST {endpoint}/chat/send
Send message to chat
Request (JSON)
Header Authorization: Bearer <access_token>
messagestring
Response
Agent
GET {endpoint}/agent/list
Get a list of agents with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of agents with parameters
a_crcstring - agent type hasha_idstring - agent ida_namestring - agent typea_session_keystring - session encrypt key (base64)a_listenerstring - listener namea_asyncbool - is async modea_external_ipstring - external IPa_internal_ipstring - internal IPa_gmt_offsetint - GMT offseta_sleepint - session sleep timea_jitterint - session sleep jittera_pidint - PIDa_tidint - TIDa_archstring - process archa_elevatedbool - is elevated sessiona_processstring - process namea_osint - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )a_os_descstring - OS descriptiona_domainstring - domain namea_computerstring - computer namea_usernamestring - usernamea_impersonatedstring - impersonated usernamea_oemcpint - OemCPacpint - ACPa_create_timeint - creation time in UNIX timestamp formata_last_tickint - last tick in UNIX timestamp formata_killdateint - packed kill datea_workingtimeint - packed working timea_tagsstring - taga_markstring - marka_colorstring - backgroud and line colora_targetstring - target ID
POST {endpoint}/agent/generate
Build and download agent
Request (JSON)
Header Authorization: Bearer <access_token>
listener_namestring - listener namelistener_typestring - listener registration nameagentstring - agent registration nameconfigstring - agent configuration
Response
Payload content
POST {endpoint}/agent/remove
Remove agent data
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id_array[strings] - list of agent IDs
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/set/tag
Set a tag for an agent
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id_array[strings] - list of agent IDstagstring - agent tag
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/set/mark
Set a mark for an agent
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id_array[strings] - list of agent IDsbcstring - background colorfcstring - foreground colorresetbool - if true, set default color
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/set/tag
Set a tag for an agent
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id_array[strings] - list of agent IDstagstring - agent tag
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/set/impersonate
Set a impersonate data for an agent
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstrings - agent IDimpersonatestring - impersonate nameelevatedbool - is elevate context
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/command/execute
Create a task for the agent
Request (JSON)
Header Authorization: Bearer <access_token>
idstring - agent IDuibool - UI mode (the task is not saved and does not have a callback)namestring - agent registration namecmdlinestring - full commanddatastring - parsed command dataax_hook_idstring - AxHook ID
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/console/remove
Remove agent console data
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id_array[strings] - list of agent IDs
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/task/save
Save data to Task Manager
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstrings - agent IDcommand_linestring - full command linemessage_typeint - result message type (6 - error, 7 - success)messagestring - task messageclear_textstring - task output
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/task/cancel
Cancel hosted tasks
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstrings - agent ID
tasks_array[strings] - list of task IDs
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/agent/task/delete
Remove task from Task Manager
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstrings - agent ID
tasks_array[strings] - list of task IDs
Response (JSON)
okbool - statusmessagestring - empty string or error text
Listener
GET {endpoint}/listener/list
Get a list of listeners with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of listeners with parameters
l_namestring - listener namel_reg_namestring - listener registration namel_protocolstring - protocoll_typestring - listener typel_bind_hoststring - bind host
l_bind_portstring - bind portl_agent_addrstring - callback hosts & portsl_statusstring - running status
l_datastring - listener config data
l_watermarkstring - process name
POST {endpoint}/listener/create
Create and start listener
Request (JSON)
Header Authorization: Bearer <access_token>
namestring - listener nametypestring - listener registration nameconfigstring - listener config data
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/listener/edit
Edit listener config
Request (JSON)
Header Authorization: Bearer <access_token>
namestring - listener nametypestring - listener registration nameconfigstring - listener config data
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/listener/stop
Stop and delete listener
Request (JSON)
Header Authorization: Bearer <access_token>
namestring - listener nametypestring - listener registration name
Response (JSON)
okbool - statusmessagestring - status string or error text
Download
GET {endpoint}/download/list
Get a list of downloads with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of downloads with parameters
d_file_idstring - file IDd_agent_idstring - agent IDd_agent_namestring - agent registration named_userstring - session usernamed_computerstring - session computer
d_remote_pathstring - remote file pathd_total_sizeint - total file sized_recv_sizeint - receive file size
d_dateint - date in UNIX timestamp format
d_stateint - download status (1 - running, 2 - stopped, 3 - finished)
POST {endpoint}/download/sync
Download file content
Request (JSON)
Header Authorization: Bearer <access_token>
file_idstring - file ID
Response (JSON) success
okbool - statusfilenamestring - file basenamecontentstring - file content in base64
Response (JSON) error
okbool - statusmessagestring - error text
POST {endpoint}/download/delete
Delete file
Request (JSON)
Header Authorization: Bearer <access_token>
file_idstring - file ID
Response (JSON) error
okbool - statusmessagestring - status string or error text
Screen
GET {endpoint}/screen/list
Get a list of screenshots with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of screenshots with parameters
s_screen_idstring - screen IDs_userstring - session usernames_computerstring - session computer
s_notestring - screenshot noted_dateint - date in UNIX timestamp format
d_contentstring - screenshot content in base64
POST {endpoint}/screen/setnote
Set a note for a screenshot
Request (JSON)
Header Authorization: Bearer <access_token>
screen_id_array[strings] - list of screen IDsnotestring - screenshot note
Response (JSON)
okbool - statusmessagestring - empty string or error text
POST {endpoint}/screen/remove
Remove a screenshot
Request (JSON)
Header Authorization: Bearer <access_token>
screen_id_array[strings] - list of screen IDs
Response (JSON)
okbool - statusmessagestring - empty string or error text
Creds
GET {endpoint}/creds/list
Get a list of credentials with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of credentials with parameters
c_creds_idstring - creds IDc_usernamestring - loginc_passwordstring - passwordc_realmstring - domainc_typestring - creds typec_tagstring - creds tagd_dateint - date in UNIX timestamp formatd_storagestring - creds storagec_agent_idstring - agent IDc_hoststring - session computer
POST {endpoint}/creds/add
Store credentials to Creds Manager
Request (JSON)
Header Authorization: Bearer <access_token>
creds- List of credentials with parametersusernamestring - loginpasswordstring - passwordrealmstring - domaintypestring - creds typetagstring - creds tagstoragestring - creds storagehoststring - session computer
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/creds/edit
Edit stored credentials
Request (JSON)
Header Authorization: Bearer <access_token>
cred_idstring - creds ID
usernamestring - loginpasswordstring - password
realmstring - domain
typestring - creds type
tagstring - creds tag
storagestring - creds storage
hoststring - session computer
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/creds/set/tag
Set creds tag
Request (JSON)
Header Authorization: Bearer <access_token>
id_array[string] - list of creds IDstagstring - tag for the creds
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/creds/remove
Remove stored credentials
Request (JSON)
Header Authorization: Bearer <access_token>
cred_id_array[string] - list of creds IDs
Response (JSON)
okbool - statusmessagestring - status string or error text
Targets
GET {endpoint}/targets/list
Get a list of targets with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of targets with parameters
t_target_idstring - target ID
t_computerstring - hostnamet_domainstring - domain namet_addressstring - host IP addresst_osint - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )t_os_descstring - OS descriptiont_tagstring - target tagt_infostring - target infod_dateint - date in UNIX timestamp format
t_alivebool - is alive targett_agents[string] - list of agents ID
POST {endpoint}/targets/add
Store credentials to Creds Manager
Request (JSON)
Header Authorization: Bearer <access_token>
targets- List of targets with parameterscomputerstring - hostnamedomainstring - domain nameaddressstring - host IP addressosint - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )os_descstring - OS descriptiontagstring - target taginfostring - target infoalivebool - is alive target
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/targets/edit
Edit stored target
Request (JSON)
Header Authorization: Bearer <access_token>
t_target_idstring - target ID
t_computerstring - hostnamet_domainstring - domain namet_addressstring - host IP addresst_osint - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )t_os_descstring - OS descriptiont_tagstring - target tagt_infostring - target info
t_alivebool - is alive target
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/targets/set/tag
Set target tag
Request (JSON)
Header Authorization: Bearer <access_token>
id_array[string] - list of target IDstagstring - tag for the target
Response (JSON)
okbool - statusmessagestring - status string or error text
POST {endpoint}/targets/remove
Remove stored targets
Request (JSON)
Header Authorization: Bearer <access_token>
target_id_array[string] - list of target IDs
Response (JSON)
okbool - statusmessagestring - status string or error text
Tunnel
GET {endpoint}/tunnel/list
Get a list of tunnels with full information
Request
Header Authorization: Bearer <access_token>
Response (JSON)
List of tunnels with parameters
p_tunnel_idstring - tunnel IDp_agent_idstring - agent ID
p_computerstring - session computerp_usernamestring - session userp_processstring - session process
p_typestring - tunnel typep_infostring - tunnel info
p_interfacestring - listen addressp_portstring - listen portp_clientstring - listen clientp_fhoststring - forward addressp_fportstring - forward portp_auth_userstring - proxy loginp_auth_passstring - proxy password
POST {endpoint}/start/socks5
Start socks5 proxy
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstring - agent IDlistenbool - is listen port on teamserverdescstring - tunnel infol_hoststring - listen addressl_portint - listen portuse_authbool - use authenticationusernamestring - proxy loginpasswordstring - proxy password
Response (JSON)
okbool - statusmessagestring - tunnel ID or error text
POST {endpoint}/start/socks4
Start socks4 proxy
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstring - agent IDlistenbool - is listen port on teamserverdescstring - tunnel infol_hoststring - listen addressl_portint - listen port
Response (JSON)
okbool - statusmessagestring - tunnel ID or error text
POST {endpoint}/start/lportfwd
Start local port forwarding
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstring - agent IDlistenbool - is listen port on teamserverdescstring - tunnel infol_hoststring - listen addressl_portint - listen port
t_hoststring - target addresst_portint - target port
Response (JSON)
okbool - statusmessagestring - tunnel ID or error text
POST {endpoint}/start/rportfwd
Start reverse port forwarding
Request (JSON)
Header Authorization: Bearer <access_token>
agent_idstring - agent IDlistenbool - is listen port on teamserverdescstring - tunnel info
portint - listen portt_hoststring - target addresst_portint - target port
Response (JSON)
okbool - statusmessagestring - tunnel ID or error text
Last updated