Modules

Read Modules

get

Query parameters

hide_disabledbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/modules

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

No content

Read Module

get

Path parameters

uidstringRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringRequired

enabledbooleanRequired

descriptionstringRequired

backgroundbooleanRequired

languagestring · enumRequiredPossible values:

min_language_versionstring · nullableOptional

needs_adminbooleanRequired

opsec_safebooleanRequired

techniquesstring[]Required

tacticsstring[]Required

softwarestring · nullableOptional

commentsstring[]Required

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/modules/{uid}

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

{
  "id": "text",
  "name": "text",
  "enabled": true,
  "authors": [
    {
      "name": "text",
      "handle": "text",
      "link": "text"
    }
  ],
  "description": "text",
  "background": true,
  "language": "python",
  "min_language_version": "text",
  "needs_admin": true,
  "opsec_safe": true,
  "techniques": [
    "text"
  ],
  "tactics": [
    "text"
  ],
  "software": "text",
  "comments": [
    "text"
  ],
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {
      "description": "text",
      "required": true,
      "value": "text",
      "suggested_values": [
        "text"
      ],
      "strict": true,
      "editable": true,
      "value_type": "STRING",
      "internal": true,
      "depends_on": [
        {
          "name": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  }
}

Update Module

put

Path parameters

uidstringRequired

Body

enabledbooleanRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringRequired

enabledbooleanRequired

descriptionstringRequired

backgroundbooleanRequired

languagestring · enumRequiredPossible values:

min_language_versionstring · nullableOptional

needs_adminbooleanRequired

opsec_safebooleanRequired

techniquesstring[]Required

tacticsstring[]Required

softwarestring · nullableOptional

commentsstring[]Required

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/modules/{uid}

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

{
  "enabled": true
}

{
  "id": "text",
  "name": "text",
  "enabled": true,
  "authors": [
    {
      "name": "text",
      "handle": "text",
      "link": "text"
    }
  ],
  "description": "text",
  "background": true,
  "language": "python",
  "min_language_version": "text",
  "needs_admin": true,
  "opsec_safe": true,
  "techniques": [
    "text"
  ],
  "tactics": [
    "text"
  ],
  "software": "text",
  "comments": [
    "text"
  ],
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {
      "description": "text",
      "required": true,
      "value": "text",
      "suggested_values": [
        "text"
      ],
      "strict": true,
      "editable": true,
      "value_type": "STRING",
      "internal": true,
      "depends_on": [
        {
          "name": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  }
}

Read Module Script

get

Path parameters

uidstringRequired

Responses

200

Successful Response

application/json

module_idstringRequired

scriptstringRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/modules/{uid}/script

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

{
  "module_id": "text",
  "script": "text"
}

Update Bulk Enable

put

Body

modulesstring[]Required

enabledbooleanRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/modules/bulk/enable

PUT /api/v2/modules/bulk/enable HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "modules": [
    "text"
  ],
  "enabled": true
}

No content

Reload Modules

post

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

post/api/v2/modules/reload

POST /api/v2/modules/reload HTTP/1.1
Accept: */*

No content

Reset Modules

post

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

post/api/v2/modules/reset

POST /api/v2/modules/reset HTTP/1.1
Accept: */*

No content