Payloads¶
Build, download, manage, and inspect agent payload binaries.
Auto-generated
This page is generated from source code by the schema extractor. Do not edit by hand — changes will be overwritten.
mythic_get_payloads¶
Get a list of all payloads in Mythic
No parameters.
mythic_get_payload¶
Get details of a specific payload by UUID
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to retrieve |
mythic_get_payload_types¶
Get list of available payload types (agent types). Each payload type includes a supported_c2_profiles array listing which C2 profiles it can use. Use this to verify C2 profile compatibility BEFORE creating a payload.
No parameters.
mythic_create_payload¶
Create/build a new payload
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_type | string | required | Payload type name (agent type) |
description | string | optional | Description of the payload |
tag | string | optional | Tag for the payload |
filename | string | optional | Filename for the payload |
os | string | optional | Operating system for the payload |
selected_os | string | optional | Selected OS variant |
commands | []string | optional | List of command names to include |
c2_profiles | []map[string]any | optional | C2 profile configurations. Each entry is {\ |
build_parameters | map[string]any | optional | Build parameter key-value pairs |
wrapper_payload | string | optional | UUID of payload to wrap |
mythic_update_payload¶
Update a payload's properties (description, tag, etc.)
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to update |
description | *string | optional | Update payload description |
callback_alert | *bool | optional | Update callback alert setting |
deleted | *bool | optional | Mark payload as deleted |
mythic_delete_payload¶
Delete a payload from Mythic
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to delete |
mythic_rebuild_payload¶
Rebuild/regenerate an existing payload
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to rebuild |
mythic_export_payload_config¶
Export a payload's configuration as JSON
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to export |
mythic_get_payload_commands¶
Get list of commands available in a payload
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_id | int | required | ID of the payload |
mythic_get_payload_on_host¶
Get list of payloads deployed on hosts in an operation
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
operation_id | int | required | ID of the operation |
mythic_wait_for_payload¶
Wait for a payload build to complete with timeout
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to wait for |
timeout | int | optional | Timeout in seconds (default 60) |
mythic_download_payload¶
Get a one-time download URL for a built payload binary. Use curl or wget with the returned download_url to fetch the file. The URL token is single-use and expires after 5 minutes.
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
payload_uuid | string | required | UUID of the payload to download |