MAGIC™ API
Project description
cythereal-magic
This Python package is automatically generated by the Swagger Codegen project:
- API version: 2.0.0 (v2)
- Package version: 0.0.2
- Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit https://cythereal.com
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import cythereal_magic
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import cythereal_magic
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import cythereal_magic
from cythereal_magic.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = cythereal_magic.EmailsApi(cythereal_magic.ApiClient(configuration))
email_id = NULL # object |
explain = NULL # object | Shows the explain for this endpoint (optional)
format = NULL # object | Format of the response from this endpoint (optional)
download = NULL # object | Determines whether to download the response. (Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = NULL # object | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
expand_mask = NULL # object | Comma separated string containing a list of relation keys to `expand` and show the entire object inline. REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
read_mask = NULL # object | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
try:
# Retrieves information for a single email
api_instance.get_email(email_id, explain=explain, format=format, download=download, filename=filename, expand_mask=expand_mask, read_mask=read_mask)
except ApiException as e:
print("Exception when calling EmailsApi->get_email: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| EmailsApi | get_email | GET /emails/{email_id}/ | Retrieves information for a single email |
| FilesApi | add_file | POST /files/{binary_id}/ | Adds a publicly accessible file to your account |
| FilesApi | add_file_tag | POST /files/{binary_id}/tags/{tag_id}/ | Associate an existing tag with a file |
| FilesApi | add_payload | POST /files/{binary_id}/payload/{payload_id}/ | Manually add a payload connection to a file |
| FilesApi | bulk_file_operation | POST /files/bulk/ | Allows for actions to be carried out on bulk sets of files |
| FilesApi | create_file_category | POST /files/{binary_id}/categories/ | Creates a new custom category label for a file |
| FilesApi | create_file_family | POST /files/{binary_id}/families/ | Creates a new custom family label for a file |
| FilesApi | create_file_job | POST /files/{binary_id}/jobs/ | Send a file for reprocessing |
| FilesApi | create_file_note | POST /files/{binary_id}/notes/ | Attaches a note to a file |
| FilesApi | delete_file_note | DELETE /files/{binary_id}/notes/{note_id}/ | Deletes a specified user note attached to a file |
| FilesApi | delete_payload_relationship | DELETE /files/{binary_id}/payload/ | Manually remove a payload connection from a file |
| FilesApi | download_file | GET /files/{binary_id}/download/ | Download file |
| FilesApi | get_file | GET /files/{binary_id}/ | Retrieves information for a single file |
| FilesApi | get_file_campaign | GET /files/{binary_id}/campaign/ | Retrieves a file's campaign information |
| FilesApi | get_file_note | GET /files/{binary_id}/notes/{note_id}/ | Retrieves a single note attached to a file |
| FilesApi | get_file_reputation | GET /files/{binary_id}/reputation/ | Retrieves the reputation status of the file |
| FilesApi | get_file_yara | GET /files/{binary_id}/yara/ | Returns a yara rule for the given file |
| FilesApi | list_file_categories | GET /files/{binary_id}/categories/ | Retrieves a file's category labels |
| FilesApi | list_file_children | GET /files/{binary_id}/children/ | Lists all files that were extracted as children |
| FilesApi | list_file_families | GET /files/{binary_id}/families/ | Retrieves a file's family labels |
| FilesApi | list_file_genomics | GET /files/{binary_id}/genomics/ | Retrieves a file's genomics |
| FilesApi | list_file_indicators | GET /files/{binary_id}/indicators/ | Lists the Indicators of Compromise associated with a file |
| FilesApi | list_file_labels | GET /files/{binary_id}/labels/ | Gets labels for a file |
| FilesApi | list_file_matches | GET /files/{binary_id}/matches/ | Gets matches for a file |
| FilesApi | list_file_notes | GET /files/{binary_id}/notes/ | Retrieves all user generated notes for file |
| FilesApi | list_file_parents | GET /files/{binary_id}/parents/ | Retrieves a file's parent files |
| FilesApi | list_file_procedure_genomics | GET /files/{binary_id}/genomics/{rva}/ | Retrieves a procedure's genomics |
| FilesApi | list_file_procedures | GET /files/{binary_id}/procedures/ | Lists all procedures and their information for the given file |
| FilesApi | list_file_similarities | GET /files/{binary_id}/similarities/ | Retrieves similar file matches for the specified file |
| FilesApi | list_file_strings | GET /files/{binary_id}/strings/ | Gets strings for a file |
| FilesApi | list_file_tags | GET /files/{binary_id}/tags/ | List all user tags associated with a file |
| FilesApi | list_files | GET /files/ | List user files based on the parameters specified |
| FilesApi | remove_all_file_owners | DELETE /files/{binary_id}/owners/ | Removes all owners from file |
| FilesApi | remove_file | DELETE /files/{binary_id}/ | Removes a user's ownership from a single file |
| FilesApi | remove_file_tag | DELETE /files/{binary_id}/tags/{tag_id}/ | Remove an existing tag from a file |
| FilesApi | search_for_file | GET /files/search/ | Search for files based on given parameters |
| FilesApi | update_file | PATCH /files/{binary_id}/ | Updates a single file |
| FilesApi | upload_file | POST /files/ | Upload new files for processing |
| GenomicsApi | compare_files | GET /genomics/compare/ | Takes in a list of files and sends back comparison results (slow) |
| GroupsApi | add_member | POST /groups/{id}/members/{member_id}/ | Adds the `member_id` user to the `id` group |
| GroupsApi | add_new_member | POST /groups/{id}/members/ | Adds the given user to this group |
| GroupsApi | bulk_group_operation | POST /groups/bulk/ | Bulk operations on Group resources |
| GroupsApi | create_group | POST /groups/ | Create a new group |
| GroupsApi | delete_group | DELETE /groups/{id}/ | Deletes a group |
| GroupsApi | get_group | GET /groups/{id}/ | Retrieves detailed information on a single group |
| GroupsApi | get_member | GET /groups/{id}/members/{member_id}/ | Returns the user with `member_id` with their `id` group settings |
| GroupsApi | group_login | GET /groups/{id}/login/ | Returns a jwt Token for this group |
| GroupsApi | group_logout | GET /groups/logout/ | Converts the group jwt back into a single user jwt |
| GroupsApi | list_groups | GET /groups/ | List all accessible groups |
| GroupsApi | list_members | GET /groups/{id}/members/ | List all members of a group |
| GroupsApi | remove_member | DELETE /groups/{id}/members/{member_id}/ | Removes the `member_id` user from the `id` group |
| GroupsApi | update_group | PATCH /groups/{id}/ | Updates a group |
| GroupsApi | update_member | PATCH /groups/{id}/members/{member_id}/ | Updates the `member_id` user in the `id` group |
| IndicatorsApi | create_ioc | POST /indicators/ | Manually creates a new indicator of compromise |
| IndicatorsApi | list_ioc_files | GET /indicators/files/ | Lists all ioc files |
| IndicatorsApi | list_iocs | GET /indicators/ | Lists all indicators associated with a user account |
| IndicatorsApi | upload_ioc_file | POST /indicators/files/ | Upload a text or csv file for IoC Extraction |
| ProceduresApi | bulk_procedure_operation | POST /procedures/bulk/ | Get procedures in bulk |
| ProceduresApi | get_procedure | GET /procedures/{proc_hash}/ | Get a single procedure |
| ProceduresApi | list_procedure_files | GET /procedures/{proc_hash}/files/ | Retrieves a procedure's files |
| ProceduresApi | list_procedure_similarities | GET /procedures/{proc_hash}/similarities/ | Lists a procedure's similarities |
| ProceduresApi | list_procedures | GET /procedures/ | Get all procedures |
| ReportsApi | get_archive_report | GET /reports/{binary_id}/archive/ | Retrieves the report info of a container like file |
| ReportsApi | get_report_features | GET /reports/{binary_id}/features/ | Retrieves the genomic features of a file |
| SearchApi | count_search_results | GET /search/count/ | Returns total count of results via search |
| SearchApi | search_files | GET /search/ | Returns files found via search |
| SupportApi | report_bug | POST /support/bug/ | Allows users to report a bug within the system |
| TagsApi | bulk_tag_operation | POST /tags/bulk/ | Lists information on a bulk selection of tags |
| TagsApi | create_tag | POST /tags/ | Create a new Project for tagging files |
| TagsApi | delete_tag | DELETE /tags/{id}/ | Deletes a tag |
| TagsApi | delete_tags | DELETE /tags/ | Delete tags in your collection |
| TagsApi | get_tag | GET /tags/{id}/ | Retrieves detailed information on a single tag |
| TagsApi | list_tagged_files | GET /tags/{id}/files/ | Lists all files associated with this tag |
| TagsApi | list_tags | GET /tags/ | List all tags |
| TagsApi | remove_tags | DELETE /tags/{id}/files/ | Removes all user tags from a file |
| TagsApi | update_tag | PATCH /tags/{id}/ | Updates a tag |
| TagsApi | update_tags | PATCH /tags/ | Updates all tags in your collection |
| UsersApi | deactivate_account | DELETE /users/me/ | Deactivate your account |
| UsersApi | get_account | GET /users/me/ | Retrieve your account information |
| UsersApi | get_my_group | GET /users/me/groups/{id}/ | Retrieve info for a group |
| UsersApi | leave_my_group | DELETE /users/me/groups/{id}/ | Leave group |
| UsersApi | leave_my_groups | DELETE /users/me/groups/ | Leave all groups |
| UsersApi | list_my_groups | GET /users/me/groups/ | Lists your groups |
| UsersApi | update_account | PATCH /users/me/ | Update your account information |
| YaraApi | create_yara | POST /yara/ | Create Yara Rule based on specific file hashes |
| YaraApi | yara_procedure_matches | GET /yara/{binary_id}/matches/ | Get similar binaries based off of potential yara procedure matches |
Documentation For Models
Documentation For Authorization
All endpoints do not require authorization.
Author
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cythereal-magic-0.0.4.tar.gz
(134.4 kB
view hashes)
