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 login

  • password string - operator password

Response (JSON)

  • access_token string - JWT access token

  • refresh_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 - status

  • message 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 hash

  • a_id string - agent id

  • a_name string - agent type

  • a_session_key string - session encrypt key (base64)

  • a_listener string - listener name

  • a_async bool - is async mode

  • a_external_ip string - external IP

  • a_internal_ip string - internal IP

  • a_gmt_offset int - GMT offset

  • a_sleep int - session sleep time

  • a_jitter int - session sleep jitter

  • a_pid int - PID

  • a_tid int - TID

  • a_arch string - process arch

  • a_elevated bool - is elevated session

  • a_process string - process name

  • a_os int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )

  • a_os_desc string - OS description

  • a_domain string - domain name

  • a_computer string - computer name

  • a_username string - username

  • a_impersonated string - impersonated username

  • a_oemcp int - OemCP

  • acp int - ACP

  • a_create_time int - creation time in UNIX timestamp format

  • a_last_tick int - last tick in UNIX timestamp format

  • a_killdate int - packed kill date

  • a_workingtime int - packed working time

  • a_tags string - tag

  • a_mark string - mark

  • a_color string - backgroud and line color

  • a_target string - target ID

POST {endpoint}/agent/generate

Build and download agent

Request (JSON)

Header Authorization: Bearer <access_token>

  • listener_name string - listener name

  • listener_type string - listener registration name

  • agent string - agent registration name

  • config 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 - status

  • message 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 IDs

  • tag string - agent tag

Response (JSON)

  • ok bool - status

  • message 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 IDs

  • bc string - background color

  • fc string - foreground color

  • reset bool - if true, set default color

Response (JSON)

  • ok bool - status

  • message 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 IDs

  • tag string - agent tag

Response (JSON)

  • ok bool - status

  • message 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 ID

  • impersonate string - impersonate name

  • elevated bool - is elevate context

Response (JSON)

  • ok bool - status

  • message 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 ID

  • ui bool - UI mode (the task is not saved and does not have a callback)

  • name string - agent registration name

  • cmdline string - full command

  • data string - parsed command data

  • ax_hook_id string - AxHook ID

Response (JSON)

  • ok bool - status

  • message 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 - status

  • message 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 ID

  • command_line string - full command line

  • message_type int - result message type (6 - error, 7 - success)

  • message string - task message

  • clear_text string - task output

Response (JSON)

  • ok bool - status

  • message 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 - status

  • message 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 - status

  • message 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 name

  • l_reg_name string - listener registration name

  • l_protocol string - protocol

  • l_type string - listener type

  • l_bind_host string - bind host

  • l_bind_port string - bind port

  • l_agent_addr string - callback hosts & ports

  • l_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 name

  • type string - listener registration name

  • config string - listener config data

Response (JSON)

  • ok bool - status

  • message string - status string or error text

POST {endpoint}/listener/edit

Edit listener config

Request (JSON)

Header Authorization: Bearer <access_token>

  • name string - listener name

  • type string - listener registration name

  • config string - listener config data

Response (JSON)

  • ok bool - status

  • message string - status string or error text

POST {endpoint}/listener/stop

Stop and delete listener

Request (JSON)

Header Authorization: Bearer <access_token>

  • name string - listener name

  • type string - listener registration name

Response (JSON)

  • ok bool - status

  • message 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 ID

  • d_agent_id string - agent ID

  • d_agent_name string - agent registration name

  • d_user string - session username

  • d_computer string - session computer

  • d_remote_path string - remote file path

  • d_total_size int - total file size

  • d_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 - status

  • filename string - file basename

  • content string - file content in base64

Response (JSON) error

  • ok bool - status

  • message 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 - status

  • message 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 ID

  • s_user string - session username

  • s_computer string - session computer

  • s_note string - screenshot note

  • d_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 IDs

  • note string - screenshot note

Response (JSON)

  • ok bool - status

  • message 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 - status

  • message 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 ID

  • c_username string - login

  • c_password string - password

  • c_realm string - domain

  • c_type string - creds type

  • c_tag string - creds tag

  • d_date int - date in UNIX timestamp format

  • d_storage string - creds storage

  • c_agent_id string - agent ID

  • c_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 parameters

    • username string - login

    • password 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 - status

  • message 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 - login

  • password 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 - status

  • message 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 IDs

  • tag string - tag for the creds

Response (JSON)

  • ok bool - status

  • message 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 - status

  • message 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 - hostname

  • t_domain string - domain name

  • t_address string - host IP address

  • t_os int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )

  • t_os_desc string - OS description

  • t_tag string - target tag

  • t_info string - target info

  • d_date int - date in UNIX timestamp format

  • t_alive bool - is alive target

  • t_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 parameters

    • computer string - hostname

    • domain string - domain name

    • address string - host IP address

    • os int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )

    • os_desc string - OS description

    • tag string - target tag

    • info string - target info

    • alive bool - is alive target

Response (JSON)

  • ok bool - status

  • message 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 - hostname

  • t_domain string - domain name

  • t_address string - host IP address

  • t_os int - OS type (0 - unknown, 1- windows, 2 - Linux, 3 - MacOS )

  • t_os_desc string - OS description

  • t_tag string - target tag

  • t_info string - target info

  • t_alive bool - is alive target

Response (JSON)

  • ok bool - status

  • message 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 IDs

  • tag string - tag for the target

Response (JSON)

  • ok bool - status

  • message 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 - status

  • message 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 ID

  • p_agent_id string - agent ID

  • p_computer string - session computer

  • p_username string - session user

  • p_process string - session process

  • p_type string - tunnel type

  • p_info string - tunnel info

  • p_interface string - listen address

  • p_port string - listen port

  • p_client string - listen client

  • p_fhost string - forward address

  • p_fport string - forward port

  • p_auth_user string - proxy login

  • p_auth_pass string - proxy password

POST {endpoint}/start/socks5

Start socks5 proxy

Request (JSON)

Header Authorization: Bearer <access_token>

  • agent_id string - agent ID

  • listen bool - is listen port on teamserver

  • desc string - tunnel info

  • l_host string - listen address

  • l_port int - listen port

  • use_auth bool - use authentication

  • username string - proxy login

  • password string - proxy password

Response (JSON)

  • ok bool - status

  • message string - tunnel ID or error text

POST {endpoint}/start/socks4

Start socks4 proxy

Request (JSON)

Header Authorization: Bearer <access_token>

  • agent_id string - agent ID

  • listen bool - is listen port on teamserver

  • desc string - tunnel info

  • l_host string - listen address

  • l_port int - listen port

Response (JSON)

  • ok bool - status

  • message 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 ID

  • listen bool - is listen port on teamserver

  • desc string - tunnel info

  • l_host string - listen address

  • l_port int - listen port

  • t_host string - target address

  • t_port int - target port

Response (JSON)

  • ok bool - status

  • message 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 ID

  • listen bool - is listen port on teamserver

  • desc string - tunnel info

  • port int - listen port

  • t_host string - target address

  • t_port int - target port

Response (JSON)

  • ok bool - status

  • message string - tunnel ID or error text

POST {endpoint}/set/info

Set tunnel info

Request (JSON)

Header Authorization: Bearer <access_token>

  • p_tunnel_id string - tunnel ID

  • p_info string - tunnel info

Response (JSON)

  • ok bool - status

  • message string - tunnel ID or error text

POST {endpoint}/stop

Stop tunnel

Request (JSON)

Header Authorization: Bearer <access_token>

  • p_tunnel_id string - tunnel ID

Response (JSON)

  • ok bool - status

  • message string - tunnel ID or error text

Last updated