Modules

Read Modules

get
Query parameters
hide_disabledbooleanOptionalDefault: false
Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v2/modules

No content

Read Module

get
Path parameters
uidstringRequired
Responses
chevron-right
200

Successful Response

application/json
idstringRequired
namestringRequired
enabledbooleanRequired
descriptionstringRequired
backgroundbooleanRequired
languagestring · enumRequiredPossible values:
min_language_versionany ofOptional
stringOptional
or
nullOptional
needs_adminbooleanRequired
opsec_safebooleanRequired
techniquesstring[]Required
tacticsstring[]Required
softwareany ofOptional
stringOptional
or
nullOptional
commentsstring[]Required
get
/api/v2/modules/{uid}

Update Module

put
Path parameters
uidstringRequired
Body
enabledbooleanRequired
Responses
chevron-right
200

Successful Response

application/json
idstringRequired
namestringRequired
enabledbooleanRequired
descriptionstringRequired
backgroundbooleanRequired
languagestring · enumRequiredPossible values:
min_language_versionany ofOptional
stringOptional
or
nullOptional
needs_adminbooleanRequired
opsec_safebooleanRequired
techniquesstring[]Required
tacticsstring[]Required
softwareany ofOptional
stringOptional
or
nullOptional
commentsstring[]Required
put
/api/v2/modules/{uid}

Read Module Script

get
Path parameters
uidstringRequired
Responses
chevron-right
200

Successful Response

application/json
module_idstringRequired
scriptstringRequired
get
/api/v2/modules/{uid}/script

Update Bulk Enable

put
Body
modulesstring[]Required
enabledbooleanRequired
Responses
put
/api/v2/modules/bulk/enable

No content

Reload Modules

post
Responses
post
/api/v2/modules/reload

No content

Reset Modules

post
Responses
post
/api/v2/modules/reset

No content

Last updated

Was this helpful?