Agents

Read File Root

get

Path parameters

agent_idstringRequired

Responses

200

Successful Response

application/json

Responseany

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/{agent_id}/files/root

HTTPcURLJavaScriptPython

GET /api/v2/agents/{agent_id}/files/root HTTP/1.1
Accept: */*

No content

Read File

get

Path parameters

uidintegerRequired

agent_idstringRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/{agent_id}/files/{uid}

HTTPcURLJavaScriptPython

GET /api/v2/agents/{agent_id}/files/{uid} HTTP/1.1
Accept: */*

{
  "id": 1,
  "session_id": "text",
  "name": "text",
  "path": "text",
  "is_file": true,
  "parent_id": 1,
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "children": [
    {
      "id": 1,
      "session_id": "text",
      "name": "text",
      "path": "text",
      "is_file": true,
      "parent_id": 1,
      "downloads": [
        {
          "id": 1,
          "filename": "text",
          "link": "text"
        }
      ],
      "children": [
        {
          "id": 1,
          "session_id": "text",
          "name": "text",
          "path": "text",
          "is_file": true,
          "parent_id": 1,
          "downloads": [
            {
              "id": 1,
              "filename": "text",
              "link": "text"
            }
          ],
          "children": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Add Tag

post

Path parameters

uidintegerRequired

agent_idstringRequired

Body

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/{uid}/tags

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/{uid}/tags HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Update Tag

put

Path parameters

uidintegerRequired

agent_idstringRequired

tag_idintegerRequired

Body

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/agents/{agent_id}/tasks/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

PUT /api/v2/agents/{agent_id}/tasks/{uid}/tags/{tag_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Delete Tag

delete

Path parameters

uidintegerRequired

tag_idintegerRequired

agent_idstringRequired

Responses

204

Successful Response

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

/api/v2/agents/{agent_id}/tasks/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/agents/{agent_id}/tasks/{uid}/tags/{tag_id} HTTP/1.1
Accept: */*

No content

Read Tasks All Agents

get

Query parameters

limitintegerOptionalDefault: -1

pageintegerOptionalDefault: 1

include_full_inputbooleanOptionalDefault: false

include_original_outputbooleanOptionalDefault: false

include_outputbooleanOptionalDefault: true

sinceany ofOptional

string · date-timeOptional

or

nullOptional

order_bystring · enumOptionalDefault: idPossible values:

order_directionstring · enumOptionalDefault: descPossible values:

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

agentsany ofOptional

string[]Optional

or

nullOptional

usersany ofOptional

integer[]Optional

or

nullOptional

tagsany ofOptional

string[]Optional

or

nullOptional

queryany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/tasks

HTTPcURLJavaScriptPython

GET /api/v2/agents/tasks HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "input": "text",
      "full_input": "text",
      "output": "text",
      "original_output": "text",
      "user_id": 1,
      "username": "text",
      "agent_id": "text",
      "downloads": [
        {
          "id": 1,
          "filename": "text",
          "link": "text"
        }
      ],
      "module_name": "text",
      "module_options": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task_name": "text",
      "status": "queued",
      "created_at": "2026-02-02T17:30:35.988Z",
      "updated_at": "2026-02-02T17:30:35.988Z",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ],
  "limit": 1,
  "page": 1,
  "total_pages": 1,
  "total": 1
}

Read Tasks

get

Path parameters

agent_idstringRequired

Query parameters

limitintegerOptionalDefault: -1

pageintegerOptionalDefault: 1

include_full_inputbooleanOptionalDefault: false

include_original_outputbooleanOptionalDefault: false

include_outputbooleanOptionalDefault: true

sinceany ofOptional

string · date-timeOptional

or

nullOptional

order_bystring · enumOptionalDefault: idPossible values:

order_directionstring · enumOptionalDefault: descPossible values:

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

usersany ofOptional

integer[]Optional

or

nullOptional

tagsany ofOptional

string[]Optional

or

nullOptional

queryany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/{agent_id}/tasks

HTTPcURLJavaScriptPython

GET /api/v2/agents/{agent_id}/tasks HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "input": "text",
      "full_input": "text",
      "output": "text",
      "original_output": "text",
      "user_id": 1,
      "username": "text",
      "agent_id": "text",
      "downloads": [
        {
          "id": 1,
          "filename": "text",
          "link": "text"
        }
      ],
      "module_name": "text",
      "module_options": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task_name": "text",
      "status": "queued",
      "created_at": "2026-02-02T17:30:35.988Z",
      "updated_at": "2026-02-02T17:30:35.988Z",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ],
  "limit": 1,
  "page": 1,
  "total_pages": 1,
  "total": 1
}

Read Task

get

Path parameters

uidintegerRequired

agent_idstringRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/{agent_id}/tasks/{uid}

HTTPcURLJavaScriptPython

GET /api/v2/agents/{agent_id}/tasks/{uid} HTTP/1.1
Accept: */*

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Delete Task

delete

Path parameters

uidintegerRequired

agent_idstringRequired

Responses

204

Successful Response

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

/api/v2/agents/{agent_id}/tasks/{uid}

HTTPcURLJavaScriptPython

DELETE /api/v2/agents/{agent_id}/tasks/{uid} HTTP/1.1
Accept: */*

No content

Create Task Jobs

post

Path parameters

agent_idstringRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/jobs

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/jobs HTTP/1.1
Accept: */*

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Kill Job

post

Path parameters

agent_idstringRequired

Body

application/json

idintegerRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/kill_job

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/kill_job HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Stop Job

post

Path parameters

agent_idstringRequired

Body

application/json

idintegerRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/stop_job

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/stop_job HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Shell

post

Executes a command on the agent. If literal is true, it will ignore the built-in aliases such a whoami or ps and execute the command directly.

Path parameters

agent_idstringRequired

Body

application/json

commandstringRequired

literalbooleanOptionalDefault: false

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/shell

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/shell HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "command": "text",
  "literal": false
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Module

post

Path parameters

agent_idstringRequired

Body

application/json

module_idstringRequired

ignore_language_version_checkbooleanOptionalDefault: false

ignore_admin_checkbooleanOptionalDefault: false

modified_inputany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/module

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/module HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "module_id": "text",
  "ignore_language_version_check": false,
  "ignore_admin_check": false,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "modified_input": "text"
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Upload

post

Path parameters

agent_idstringRequired

Body

application/json

path_to_filestringRequired

file_idintegerRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/upload

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/upload HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "path_to_file": "text",
  "file_id": 1
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Download

post

Path parameters

agent_idstringRequired

Body

application/json

path_to_filestringRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/download

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/download HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "path_to_file": "text"
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Sysinfo

post

Path parameters

agent_idstringRequired

Body

application/json

object · SysinfoPostRequestOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/sysinfo

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/sysinfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Update Comms

post

Path parameters

agent_idstringRequired

Body

application/json

new_listener_idintegerRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/update_comms

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/update_comms HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "new_listener_id": 1
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Update Sleep

post

Path parameters

agent_idstringRequired

Body

application/json

delayintegerRequired

jitternumber · max: 1Required

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/sleep

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/sleep HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "delay": 1,
  "jitter": 1
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Update Kill Date

post

Path parameters

agent_idstringRequired

Body

application/json

kill_datestringRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/kill_date

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/kill_date HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "kill_date": "text"
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Update Working Hours

post

Path parameters

agent_idstringRequired

Body

application/json

working_hoursstringRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/working_hours

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/working_hours HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "working_hours": "text"
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Update Directory List

post

Path parameters

agent_idstringRequired

Body

application/json

pathstringRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/directory_list

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/directory_list HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "path": "text"
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Exit

post

Path parameters

agent_idstringRequired

Body

application/json

object · ExitPostRequestOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/exit

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/exit HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Create Task Socks

post

Path parameters

agent_idstringRequired

Body

application/json

portintegerRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{agent_id}/tasks/socks

HTTPcURLJavaScriptPython

POST /api/v2/agents/{agent_id}/tasks/socks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "port": 1
}

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "original_output": "text",
  "user_id": 1,
  "username": "text",
  "agent_id": "text",
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "module_name": "text",
  "module_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task_name": "text",
  "status": "queued",
  "created_at": "2026-02-02T17:30:35.988Z",
  "updated_at": "2026-02-02T17:30:35.988Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Add Tag

post

Path parameters

uidstringRequired

Body

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/agents/{uid}/tags

HTTPcURLJavaScriptPython

POST /api/v2/agents/{uid}/tags HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Update Tag

put

Path parameters

uidstringRequired

tag_idintegerRequired

Body

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/agents/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

PUT /api/v2/agents/{uid}/tags/{tag_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Delete Tag

delete

Path parameters

uidstringRequired

tag_idintegerRequired

Responses

204

Successful Response

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

/api/v2/agents/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/agents/{uid}/tags/{tag_id} HTTP/1.1
Accept: */*

No content

Read Agent Checkins All

get

Query parameters

agentsstring[]Optional

limitintegerOptionalDefault: 1000

pageintegerOptionalDefault: 1

start_dateany ofOptional

string · date-timeOptional

or

nullOptional

end_dateany ofOptional

string · date-timeOptional

or

nullOptional

order_directionstring · enumOptionalDefault: descPossible values:

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/checkins

HTTPcURLJavaScriptPython

GET /api/v2/agents/checkins HTTP/1.1
Accept: */*

{
  "records": [
    {
      "agent_id": "text",
      "checkin_time": "2026-02-02T17:30:35.988Z"
    }
  ],
  "limit": 1,
  "page": 1,
  "total_pages": 1,
  "total": 1
}

Read Agent Checkins Aggregate

get

Query parameters

agentsstring[]Optional

start_dateany ofOptional

string · date-timeOptional

or

nullOptional

end_dateany ofOptional

string · date-timeOptional

or

nullOptional

bucket_sizeany ofOptionalDefault: day

string · enumOptionalPossible values:

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/checkins/aggregate

HTTPcURLJavaScriptPython

GET /api/v2/agents/checkins/aggregate HTTP/1.1
Accept: */*

{
  "records": [
    {
      "count": 1,
      "checkin_time": "2026-02-02T17:30:35.988Z"
    }
  ],
  "start_date": "2026-02-02T17:30:35.988Z",
  "end_date": "2026-02-02T17:30:35.988Z",
  "bucket_size": "text"
}

Read Agent

get

Path parameters

uidstringRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/{uid}

HTTPcURLJavaScriptPython

GET /api/v2/agents/{uid} HTTP/1.1
Accept: */*

{
  "session_id": "text",
  "name": "text",
  "listener": "text",
  "host_id": 1,
  "hostname": "text",
  "language": "text",
  "language_version": "text",
  "delay": 1,
  "jitter": 1,
  "external_ip": "text",
  "internal_ip": "text",
  "username": "text",
  "high_integrity": true,
  "process_id": 1,
  "process_name": "text",
  "os_details": "text",
  "nonce": "text",
  "checkin_time": "2026-02-02T17:30:35.988Z",
  "lastseen_time": "2026-02-02T17:30:35.988Z",
  "parent": "text",
  "children": "text",
  "servers": "text",
  "profile": "text",
  "functions": "text",
  "kill_date": "text",
  "working_hours": "text",
  "lost_limit": 1,
  "notes": "text",
  "architecture": "text",
  "archived": true,
  "stale": true,
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Update Agent

put

Path parameters

uidstringRequired

Body

application/json

namestringRequired

notesany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/agents/{uid}

HTTPcURLJavaScriptPython

PUT /api/v2/agents/{uid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "notes": "text"
}

{
  "session_id": "text",
  "name": "text",
  "listener": "text",
  "host_id": 1,
  "hostname": "text",
  "language": "text",
  "language_version": "text",
  "delay": 1,
  "jitter": 1,
  "external_ip": "text",
  "internal_ip": "text",
  "username": "text",
  "high_integrity": true,
  "process_id": 1,
  "process_name": "text",
  "os_details": "text",
  "nonce": "text",
  "checkin_time": "2026-02-02T17:30:35.988Z",
  "lastseen_time": "2026-02-02T17:30:35.988Z",
  "parent": "text",
  "children": "text",
  "servers": "text",
  "profile": "text",
  "functions": "text",
  "kill_date": "text",
  "working_hours": "text",
  "lost_limit": 1,
  "notes": "text",
  "architecture": "text",
  "archived": true,
  "stale": true,
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Read Agents

get

Query parameters

include_archivedbooleanOptionalDefault: false

include_stalebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents

HTTPcURLJavaScriptPython

GET /api/v2/agents HTTP/1.1
Accept: */*

{
  "records": [
    {
      "session_id": "text",
      "name": "text",
      "listener": "text",
      "host_id": 1,
      "hostname": "text",
      "language": "text",
      "language_version": "text",
      "delay": 1,
      "jitter": 1,
      "external_ip": "text",
      "internal_ip": "text",
      "username": "text",
      "high_integrity": true,
      "process_id": 1,
      "process_name": "text",
      "os_details": "text",
      "nonce": "text",
      "checkin_time": "2026-02-02T17:30:35.988Z",
      "lastseen_time": "2026-02-02T17:30:35.988Z",
      "parent": "text",
      "children": "text",
      "servers": "text",
      "profile": "text",
      "functions": "text",
      "kill_date": "text",
      "working_hours": "text",
      "lost_limit": 1,
      "notes": "text",
      "architecture": "text",
      "archived": true,
      "stale": true,
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ]
}

Read Agent Checkins

get

Path parameters

uidstringRequired

Query parameters

limitintegerOptionalDefault: -1

pageintegerOptionalDefault: 1

start_dateany ofOptional

string · date-timeOptional

or

nullOptional

end_dateany ofOptional

string · date-timeOptional

or

nullOptional

order_directionstring · enumOptionalDefault: descPossible values:

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/agents/{uid}/checkins

HTTPcURLJavaScriptPython

GET /api/v2/agents/{uid}/checkins HTTP/1.1
Accept: */*

{
  "records": [
    {
      "agent_id": "text",
      "checkin_time": "2026-02-02T17:30:35.988Z"
    }
  ],
  "limit": 1,
  "page": 1,
  "total_pages": 1,
  "total": 1
}