Listeners

Add Tag

post

Path parameters

uidintegerRequired

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/listeners/{uid}/tags

HTTPcURLJavaScriptPython

POST /api/v2/listeners/{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

tag_idintegerRequired

Body

application/json

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorany 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/listeners/{uid}/tags/{tag_id}

HTTPcURLJavaScriptPython

PUT /api/v2/listeners/{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

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

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

HTTPcURLJavaScriptPython

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

No content

Read Listener

get

Path parameters

uidintegerRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/listeners/{uid}

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "name": "text",
  "enabled": true,
  "template": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-02-02T18:11:17.659Z",
  "host_address": "text",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Update Listener

put

Path parameters

uidintegerRequired

Body

application/json

namestringRequired

enabledbooleanRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/listeners/{uid}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "enabled": true,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": 1,
  "name": "text",
  "enabled": true,
  "template": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-02-02T18:11:17.659Z",
  "host_address": "text",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Delete Listener

delete

Path parameters

uidintegerRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete

/api/v2/listeners/{uid}

HTTPcURLJavaScriptPython

DELETE /api/v2/listeners/{uid} HTTP/1.1
Accept: */*

No content

Read Listeners

get

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

get

/api/v2/listeners

HTTPcURLJavaScriptPython

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

{
  "records": [
    {
      "id": 1,
      "name": "text",
      "enabled": true,
      "template": "text",
      "options": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created_at": "2026-02-02T18:11:17.659Z",
      "host_address": "text",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ]
}

Create Listener

post

Note: options['Name'] will be overwritten by name. When v1 api is eventually removed, it wil no longer be needed. :param listener_req: :param db :return:

Body

application/json

namestringRequired

templatestringRequired

Responses

201

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post

/api/v2/listeners

HTTPcURLJavaScriptPython

POST /api/v2/listeners HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 632

{
  "name": "MyListener",
  "options": {
    "BindIP": "0.0.0.0",
    "CertPath": "",
    "Cookie": "",
    "DefaultDelay": 5,
    "DefaultJitter": 0,
    "DefaultLostLimit": 60,
    "DefaultProfile": "/admin/get.php,/news.php,/login/process.php|Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko",
    "Headers": "Server:Microsoft-IIS/7.5",
    "Host": "http://localhost",
    "KillDate": "",
    "Launcher": "powershell -noP -sta -w 1 -enc ",
    "Name": "MyListener",
    "Port": "1336",
    "Proxy": "default",
    "ProxyCreds": "default",
    "StagerURI": "",
    "StagingKey": "2c103f2c4ed1e59c0b4e2e01821770fa",
    "UserAgent": "default",
    "WorkingHours": ""
  },
  "software": "",
  "tactics": [
    ""
  ],
  "techniques": [
    ""
  ],
  "template": "http"
}

{
  "id": 1,
  "name": "text",
  "enabled": true,
  "template": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-02-02T18:11:17.659Z",
  "host_address": "text",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Get Listener Autorun

get

Path parameters

uidintegerRequired

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get

/api/v2/listeners/{uid}/autorun

HTTPcURLJavaScriptPython

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

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

Update Listener Autorun

put

Path parameters

uidintegerRequired

Body

application/json

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put

/api/v2/listeners/{uid}/autorun

HTTPcURLJavaScriptPython

PUT /api/v2/listeners/{uid}/autorun HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 168

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

{
  "id": 1,
  "name": "text",
  "enabled": true,
  "template": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-02-02T18:11:17.659Z",
  "host_address": "text",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}