Resources

`Action` class

class pydragonfly.Dragonfly.Action

pydragonfly.Dragonfly.Action

EXPANDABLE_FIELDS = {'list': ['user'], 'retrieve': ['user']}

ORDERING_FIELDS = []

classmethod auto_paging_iter(params: Optional[django_rest_client.types.TParams] = None) → Generator[Tuple[django_rest_client.api_response.APIResponse, int], None, None]

classmethod list(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod retrieve(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

`Analysis` class

class pydragonfly.Dragonfly.Analysis

pydragonfly.Dragonfly.Analysis

class CreateAnalysisRequestBody(profiles: List[int], private: bool = False, allow_actions: bool = False, root: bool = False, os: Union[typing_extensions.Literal[‘WINDOWS’, ‘LINUX’], NoneType] = None, arguments: Union[List[str], NoneType] = None, dll_entrypoints: Union[List[str], NoneType] = None)

allow_actions: bool = False

arguments: Optional[List[str]] = None

dll_entrypoints: Optional[List[str]] = None

os: Optional[typing_extensions.Literal[WINDOWS, LINUX]] = None

private: bool = False

profiles: List[int]

root: bool = False

EXPANDABLE_FIELDS = {'list': [], 'retrieve': ['sample', 'reports']}

ORDERING_FIELDS = ['created_at', 'sample__filename', 'weight']

Result: alias of pydragonfly.sdk.resources.analysis.AnalysisResult

classmethod aggregate_evaluations(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod aggregate_malware_families(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod aggregate_malware_type(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod aggregate_status(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod auto_paging_iter(params: Optional[django_rest_client.types.TParams] = None) → Generator[Tuple[django_rest_client.api_response.APIResponse, int], None, None]

classmethod create(data: pydragonfly.sdk.resources.analysis.CreateAnalysisRequestBody, sample_name: str, sample_buffer: bytes, params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod list(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod retrieve(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod revoke(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

`Invitation` class

class pydragonfly.Dragonfly.Invitation

pydragonfly.Dragonfly.Invitation

EXPANDABLE_FIELDS = {'list': [], 'retrieve': []}

ORDERING_FIELDS = []

classmethod accept(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod decline(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod delete(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod list(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

`Organization` class

class pydragonfly.Dragonfly.Organization

pydragonfly.Dragonfly.Organization

Note: delete and leave methods are intentionally not provided to avoid accidents. Please use the GUI for those operations.

class CreateOrgRequestBody(name: str)

name: str

EXPANDABLE_FIELDS = {'list': ['members', 'pending_invitations'], 'retrieve': ['members', 'pending_invitations']}

class InviteRequestBody(username: str)

username: str

ORDERING_FIELDS = []

class RemoveMemberRequestBody(username: str)

username: str

classmethod create(data: pydragonfly.sdk.resources.organization.CreateOrgRequestBody, params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod get(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod invite(data: pydragonfly.sdk.resources.organization.InviteRequestBody, params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod remove_member(data: pydragonfly.sdk.resources.organization.RemoveMemberRequestBody, params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

`Profile` class

class pydragonfly.Dragonfly.Profile

pydragonfly.Dragonfly.Profile

class CreateProfileRequestBody(filename: str, emulator: typing_extensions.Literal[‘qiling’, ‘speakeasy’], content: bytes)

content: bytes

emulator: typing_extensions.Literal[qiling, speakeasy]

filename: str

EXPANDABLE_FIELDS = {'list': ['user', 'permissions'], 'retrieve': ['user', 'permissions']}

ORDERING_FIELDS = ['id', 'filename', 'created_at']

class UpdateProfileRequestBody(enabled: bool)

enabled: bool

classmethod auto_paging_iter(params: Optional[django_rest_client.types.TParams] = None) → Generator[Tuple[django_rest_client.api_response.APIResponse, int], None, None]

classmethod create(data: pydragonfly.sdk.resources.profile.CreateProfileRequestBody, params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod list(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod retrieve(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod update(object_id: Union[str, int], data: pydragonfly.sdk.resources.profile.UpdateProfileRequestBody, params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

`Report` class

class pydragonfly.Dragonfly.Report

pydragonfly.Dragonfly.Report

EXPANDABLE_FIELDS = {'list': ['profile', 'analysis', 'structs_count'], 'retrieve': ['profile', 'analysis', 'structs_count']}

ORDERING_FIELDS = ['time__start_analysis', 'analysis__sample__filename', 'weight']

classmethod auto_paging_iter(params: Optional[django_rest_client.types.TParams] = None) → Generator[Tuple[django_rest_client.api_response.APIResponse, int], None, None]

classmethod list(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod matched_rules(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod retrieve(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod revoke(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

classmethod timeline(object_id: Union[str, int], params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse

`Rule` class

class pydragonfly.Dragonfly.Rule

pydragonfly.Dragonfly.Rule

class CreateRuleRequestBody(rule: str, weight: int, modules: dict, variables: List[str] = <factory>, malware_family: str = '', mitre_technique: str = None, meta_description: dict = <factory>, sensitive: bool = False)

malware_family: str = ''

meta_description: dict

mitre_technique: str = None

modules: dict

rule: str

sensitive: bool = False

variables: List[str]

weight: int

EXPANDABLE_FIELDS = {'list': ['user', 'permissions'], 'retrieve': ['user', 'actions', 'clause', 'permissions']}

ORDERING_FIELDS = ['created_at', 'rule', 'weight', 'malware_family', 'mitre_technique']

class UpdateRuleRequestBody(enabled: bool)

enabled: bool

classmethod aggregate_behaviour(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse: New in version 0.1.0.

classmethod aggregate_malware_behaviour(params: Optional[django_rest_client.types.TParams] = None) → django_rest_client.api_response.APIResponse: Deprecated in favor of aggregate_mitre_technique. Will be removed in next release.