Module: Msf::WebServices::Documentation::Api::V1::PayloadApiDoc

Includes:
Swagger::Blocks
Defined in:
lib/msf/core/web_services/documentation/api/v1/payload_api_doc.rb

Constant Summary collapse

NAME_DESC =
'A name for the payload.'
UUID_DESC =
'A payload\'s unique identifier.'
UUID_EXAMPLE =
'6dde5ce0e94c9f43'
TIMESTAMP_DESC =
'The Unix format timestamp when this payload was created.'
TIMESTAMP_EXAMPLE =
'1536777407'
ARCH_DESC =
'The architecture this payload supports.'
ARCH_EXAMPLE =
'x86'
PLATFORM_DESC =
'The platform this payload supports.'
PLATFORM_EXAMPLE =
'windows'
URLS_DESC =
'The unique, encoded urls used to host this payload. Only applicable for http(s) payloads.'
URLS_EXAMPLE =
['/bd5c4OlMn0OeQp9AxdvC_Q2EIcdSRvg7gzLdQwU__Mb1WtjGR8C4UbjohhRIgbmBfFFBsNJ-wZMyFZKK33aorc8qfD0xCsmxSEyHaiyjGn0ykbJOlYFF1j1HXShiKiiwbfh_wPf2uqSWk2tnaLAqwuvxPcRuDPF-kdkmDDC2']
DESCRIPTION_DESC =
'A description of why this payload was created and what it is being used for.'
WORKSPACE_ID_DESC =
'The ID of the workspace this payload belongs to.'
WORKSPACE_ID_EXAMPLE =
1
RAW_PAYLOAD_DESC =
'A URL pointing to where the binary payload can be downloaded from.'
RAW_PAYLOAD_HASH_DESC =
'The unique hash value for the generated payload binary.'
BUILD_OPTS_DESC =
'A hash containing various options used to build this payload.'