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)
username
string - operator loginpassword
string - operator password
Response (JSON)
access_token
string - JWT access tokenrefresh_token
string - JWT refresh token
POST {endpoint}/refresh
Update JWT access token
Request (JSON)
Header Authorization: Bearer <refresh_token>
Response (JSON)
access_token
string - 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>
type
string - object type: "download" or "tmp_upload"id
string - object ID
Response (JSON)
ok
bool - statusmessage
string - OTP or error text
Chat
POST {endpoint}/chat/send
Send message to chat
Request (JSON)
Header Authorization: Bearer <access_token>
message
string
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_crc
string - agent type hasha_id
string - agent ida_name
string - agent typea_session_key
string - session encrypt key (base64)a_listener
string - listener namea_async
bool - is async modea_external_ip
string - external IPa_internal_ip
string - internal IPa_gmt_offset
int - GMT offseta_sleep
int - session sleep timea_jitter
int - session sleep jittera_pid
int - PIDa_tid
int - TIDa_arch
string - process archa_elevated
bool - is elevated sessiona_process
string - process namea_os
int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )a_os_desc
string - OS descriptiona_domain
string - domain namea_computer
string - computer namea_username
string - usernamea_impersonated
string - impersonated usernamea_oemcp
int - OemCPacp
int - ACPa_create_time
int - creation time in UNIX timestamp formata_last_tick
int - last tick in UNIX timestamp formata_killdate
int - packed kill datea_workingtime
int - packed working timea_tags
string - taga_mark
string - marka_color
string - backgroud and line colora_target
string - target ID
POST {endpoint}/agent/generate
Build and download agent
Request (JSON)
Header Authorization: Bearer <access_token>
listener_name
string - listener namelistener_type
string - listener registration nameagent
string - agent registration nameconfig
string - 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)
ok
bool - statusmessage
string - 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 IDstag
string - agent tag
Response (JSON)
ok
bool - statusmessage
string - 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 IDsbc
string - background colorfc
string - foreground colorreset
bool - if true, set default color
Response (JSON)
ok
bool - statusmessage
string - 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 IDstag
string - agent tag
Response (JSON)
ok
bool - statusmessage
string - 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_id
strings - agent IDimpersonate
string - impersonate nameelevated
bool - is elevate context
Response (JSON)
ok
bool - statusmessage
string - empty string or error text
POST {endpoint}/agent/command/execute
Create a task for the agent
Request (JSON)
Header Authorization: Bearer <access_token>
id
string - agent IDui
bool - UI mode (the task is not saved and does not have a callback)name
string - agent registration namecmdline
string - full commanddata
string - parsed command dataax_hook_id
string - AxHook ID
Response (JSON)
ok
bool - statusmessage
string - 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)
ok
bool - statusmessage
string - empty string or error text
POST {endpoint}/agent/task/save
Save data to Task Manager
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
strings - agent IDcommand_line
string - full command linemessage_type
int - result message type (6 - error, 7 - success)message
string - task messageclear_text
string - task output
Response (JSON)
ok
bool - statusmessage
string - empty string or error text
POST {endpoint}/agent/task/cancel
Cancel hosted tasks
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
strings - agent ID
tasks_array
[strings] - list of task IDs
Response (JSON)
ok
bool - statusmessage
string - empty string or error text
POST {endpoint}/agent/task/delete
Remove task from Task Manager
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
strings - agent ID
tasks_array
[strings] - list of task IDs
Response (JSON)
ok
bool - statusmessage
string - 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_name
string - listener namel_reg_name
string - listener registration namel_protocol
string - protocoll_type
string - listener typel_bind_host
string - bind host
l_bind_port
string - bind portl_agent_addr
string - callback hosts & portsl_status
string - running status
l_data
string - listener config data
l_watermark
string - process name
POST {endpoint}/listener/create
Create and start listener
Request (JSON)
Header Authorization: Bearer <access_token>
name
string - listener nametype
string - listener registration nameconfig
string - listener config data
Response (JSON)
ok
bool - statusmessage
string - status string or error text
POST {endpoint}/listener/edit
Edit listener config
Request (JSON)
Header Authorization: Bearer <access_token>
name
string - listener nametype
string - listener registration nameconfig
string - listener config data
Response (JSON)
ok
bool - statusmessage
string - status string or error text
POST {endpoint}/listener/stop
Stop and delete listener
Request (JSON)
Header Authorization: Bearer <access_token>
name
string - listener nametype
string - listener registration name
Response (JSON)
ok
bool - statusmessage
string - 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_id
string - file IDd_agent_id
string - agent IDd_agent_name
string - agent registration named_user
string - session usernamed_computer
string - session computer
d_remote_path
string - remote file pathd_total_size
int - total file sized_recv_size
int - receive file size
d_date
int - date in UNIX timestamp format
d_state
int - download status (1 - running, 2 - stopped, 3 - finished)
POST {endpoint}/download/sync
Download file content
Request (JSON)
Header Authorization: Bearer <access_token>
file_id
string - file ID
Response (JSON) success
ok
bool - statusfilename
string - file basenamecontent
string - file content in base64
Response (JSON) error
ok
bool - statusmessage
string - error text
POST {endpoint}/download/delete
Delete file
Request (JSON)
Header Authorization: Bearer <access_token>
file_id
string - file ID
Response (JSON) error
ok
bool - statusmessage
string - 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_id
string - screen IDs_user
string - session usernames_computer
string - session computer
s_note
string - screenshot noted_date
int - date in UNIX timestamp format
d_content
string - 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 IDsnote
string - screenshot note
Response (JSON)
ok
bool - statusmessage
string - 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)
ok
bool - statusmessage
string - 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_id
string - creds IDc_username
string - loginc_password
string - passwordc_realm
string - domainc_type
string - creds typec_tag
string - creds tagd_date
int - date in UNIX timestamp formatd_storage
string - creds storagec_agent_id
string - agent IDc_host
string - session computer
POST {endpoint}/creds/add
Store credentials to Creds Manager
Request (JSON)
Header Authorization: Bearer <access_token>
creds
- List of credentials with parametersusername
string - loginpassword
string - passwordrealm
string - domaintype
string - creds typetag
string - creds tagstorage
string - creds storagehost
string - session computer
Response (JSON)
ok
bool - statusmessage
string - status string or error text
POST {endpoint}/creds/edit
Edit stored credentials
Request (JSON)
Header Authorization: Bearer <access_token>
cred_id
string - creds ID
username
string - loginpassword
string - password
realm
string - domain
type
string - creds type
tag
string - creds tag
storage
string - creds storage
host
string - session computer
Response (JSON)
ok
bool - statusmessage
string - 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 IDstag
string - tag for the creds
Response (JSON)
ok
bool - statusmessage
string - 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)
ok
bool - statusmessage
string - 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_id
string - target ID
t_computer
string - hostnamet_domain
string - domain namet_address
string - host IP addresst_os
int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )t_os_desc
string - OS descriptiont_tag
string - target tagt_info
string - target infod_date
int - date in UNIX timestamp format
t_alive
bool - 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 parameterscomputer
string - hostnamedomain
string - domain nameaddress
string - host IP addressos
int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )os_desc
string - OS descriptiontag
string - target taginfo
string - target infoalive
bool - is alive target
Response (JSON)
ok
bool - statusmessage
string - status string or error text
POST {endpoint}/targets/edit
Edit stored target
Request (JSON)
Header Authorization: Bearer <access_token>
t_target_id
string - target ID
t_computer
string - hostnamet_domain
string - domain namet_address
string - host IP addresst_os
int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )t_os_desc
string - OS descriptiont_tag
string - target tagt_info
string - target info
t_alive
bool - is alive target
Response (JSON)
ok
bool - statusmessage
string - 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 IDstag
string - tag for the target
Response (JSON)
ok
bool - statusmessage
string - 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)
ok
bool - statusmessage
string - 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_id
string - tunnel IDp_agent_id
string - agent ID
p_computer
string - session computerp_username
string - session userp_process
string - session process
p_type
string - tunnel typep_info
string - tunnel info
p_interface
string - listen addressp_port
string - listen portp_client
string - listen clientp_fhost
string - forward addressp_fport
string - forward portp_auth_user
string - proxy loginp_auth_pass
string - proxy password
POST {endpoint}/start/socks5
Start socks5 proxy
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
string - agent IDlisten
bool - is listen port on teamserverdesc
string - tunnel infol_host
string - listen addressl_port
int - listen portuse_auth
bool - use authenticationusername
string - proxy loginpassword
string - proxy password
Response (JSON)
ok
bool - statusmessage
string - tunnel ID or error text
POST {endpoint}/start/socks4
Start socks4 proxy
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
string - agent IDlisten
bool - is listen port on teamserverdesc
string - tunnel infol_host
string - listen addressl_port
int - listen port
Response (JSON)
ok
bool - statusmessage
string - tunnel ID or error text
POST {endpoint}/start/lportfwd
Start local port forwarding
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
string - agent IDlisten
bool - is listen port on teamserverdesc
string - tunnel infol_host
string - listen addressl_port
int - listen port
t_host
string - target addresst_port
int - target port
Response (JSON)
ok
bool - statusmessage
string - tunnel ID or error text
POST {endpoint}/start/rportfwd
Start reverse port forwarding
Request (JSON)
Header Authorization: Bearer <access_token>
agent_id
string - agent IDlisten
bool - is listen port on teamserverdesc
string - tunnel info
port
int - listen portt_host
string - target addresst_port
int - target port
Response (JSON)
ok
bool - statusmessage
string - tunnel ID or error text
Last updated