cythereal-magic

The API for accessing Unknown Cyber MAGIC products and services.

Authentication

(Head to our /auth api to register, login, or generate a token)

Supported Authentication Schemes:

HTTP Basic Authentication
API-KEY in the X-API-KEY request header
JWT token in the Authorization:"Bearer {token}" request header

Content Negotiation

There are two ways to specify the content type of the response. In order of precedence:

The Accept request header can be set with the desired mime type. The most specific version will prevail. i.e. application/json > application/*.

Accept:"application/json"
The format query parameter. (MUST be in lower case)

?format=json

Supported Formats:

query parameter	Accept Header
json	application/json	Default
xml	application/xml
csv	text/csv
txt	text/plain
explain	application/explain+json	Custom type that returns a description of usage of the endpoint

Requests

Supported HTTP Methods:

GET
POST
PATCH
DELETE
HEAD
OPTIONS

Every request supports the following query parameters:

explain - (bool) - Returns a detailed explanation of what the endpoint does, as well as potential query parameters that can be used to customize the results
download - (bool) - If set to a truthy value, acts as setting the 'Content-Disposition' header to "attachment;" and will download the response as a file.
filename - (str) - The filename to use for a downloaded file. Ignored if no file is being downloaded.
format - (str) - Used in a similar manner to the Accept Header. Use this to specify which format you want the response returned in. Defaults to application/json. Current acceptable values are:
- json - (application/json)
- xml - (application/xml)
- csv - (text/csv)
- txt - (text/plain)
- explain - (application/explain+json)
  - Custom type that returns a description of usage of the endpoint
no_links - (bool) - If set to a truthy value, links will be disabled from the response
uri - (bool) - If set to a truthy value, id lists will be returned as uris instead of id strings.

GET Conventions

Possible query parameters:

(Check each endpoint description, or use explain, for a list of available values for each parameter)

read_mask - A list of values (keys) to return for the resource or each resource within the list
- Comma separated string of variables
- Leaving this field blank will return the default values.
- Setting this value equal to * will include ALL possible keys.
- Traversal is allowed with the . operator.
- There are three special keys that can be used with all endponts
  - * - This will return all possible values available
  - _self - This will include the resources uri
  - _default - This will include all default values (Those given with an empty read_mask)
    - This would typically be used in conjunction with other 'non-default' fields
- Ex:
  - _default,family,category,_self
dynamic_mask - A list of dynamically generated values to return about the resource or each resource within the list
- Comma separated string of variables
- Operates the same as read_mask, but each variable will incur a much greater time cost.
- May cause timeouts
- Leaving this field blank or empty will return no dynamic variables.
expand_mask - A list of relational variables to expand upon and return more than just the ids
- Comma separated string of variables
- Leaving this field blank will cause all relational data to be returned as a list of ids
- Ex:
  - The children field for a file may return a list of ids normally, but with children set in the expand_mask, it can return a list of child File objects with greater details.

POST Conventions

This will create a new resource.

The resource data shall be provided in the request body.

The response will be either a 200 or 201, along with a uri to the newly created resource in the Location header.

In the case of a long running job, or reprocess, the response will be a 202 along with a job_id and it's corresponding job_uri that can be used in the /jobs/ endpoint to see the updated status

PATCH Conventions

The update data shall be provided in the request body.

Possible query parameters:

(Check each endpoint description, or use explain, for a list of available values for each parameter)

update_mask - A list of values to update with this request.
- Comma separated string of variables
- This is required to be set for any and all PATCH requests to be processed.
- ONLY the specified variables in the update_mask will be updated regardless of the data in the request body.
- An empty or missing update_mask WILL result in a 400 Bad Request response

DELETE Conventions

A successful response will return 204 No Content

Possible query parameters:

force - Forces the deletion to go through
- This is required to be set as a truthy value for any and all DELETE requests to be processed.
- Not specifying this on a DELETE request (without explain set) WILL return a 400 Bad Request response

bulk endpoints

Bulk endpoints are the ones that follow the '/<resource>/bulk/' convention. They operate in the same fashion as the single resource endpoints ('/<resource>/<resource_id>/') except they can process multiple resources on a single call.

They MUST be a POST request along with the accompanying request body parameter to work:

ids - A list of ids to operate on (For GET, PATCH, and DELETE bulk requests)
resources - A list of resources to operate on (For POST bulk requests)

Possible query parameters:

(Check each endpoint description, or use explain, for a list of available actions)

action - This is a string and can only be one of four values:
- GET - Returns a list of the resources, in the same order as provided in the request body.
- POST - Acts the same as a post on the pluralized resource endpoint.
  - Instead of an ids request body parameter being provided in the request body, a resources list of new resources must be provided.
- PATCH - Acts the same as a patch on a single resource.
  - Follows the same PATCH conventions from above*
- DELETE - Acts the same as a delete on a single resource.
  - Follows the same DELETE conventions from above*
strict - Causes the bulk endpoint to fail if a single provided id fails
- Boolean
- If set to True, the bulk call will ONLY operate if it is successful on ALL requested resources.
- If even a single resource is non-existent/forbidden, the call will fail and no side effects will take place.

Pagination:

Pagination can be done in combination with sorting and filtering on most endpoints that deal with lists (including PATCH and DELETE calls)

Pagination query paramters:

page_size - The number of results to return (default: 50)
page_count - The page used in pagination (default: 1)
skip_count - A specified number of values to skip before collecting values (default: 0)

Sorting:

Sorting can be done in combination with filtering and pagination on most endpoints that deal with lists (including PATCH and DELETE calls)

Sorting query parameter:

(Check each endpoint description, or use explain, for a list of available sorters)

order_by - A list of variables to sort the query on
- Comma separated string of variables
- Regex Pattern - ^(-?[\w]+,?)*$
- Variables are sorted in ascending order by default
- Prepend the variable with a - to change it to descending order
- Multiple sorters can be specified, with precedence matching the order of the parameter
- Ex:
  - -object_class,create_time

Filtering:

Filtering can be done in combination with pagination and sorting on most endpoints that deal with lists (including PATCH and DELETE calls)

Filters query parameter:

(Check each endpoint description, or use explain, for a list of available filters)

filters - A string of filters used to narrow down the query results.
- Semi-colon separated string of variables
- Regex patterns:
  - Single filter:
    - ^\ *(NOT\ +)?[\w]+__[a-z]+$.+$\ *
    - NOT variable__comparator(value)
  - Multiple Filters:
    - ^{SINGLE_FILTER_REGEX}(\ +(AND|OR|;)\ +{SINGLE_FILTER_REGEX})*$
    - NOT variable__comparator(value) AND NOT variable__comparator(value); variable__comparator(value)
- Logical operator order of precedence:
  - AND
  - OR
  - ; (Semi-colon separation denotes conjunction)
  - Example order of precedence:
    - exp1;exp2 AND exp3 OR exp4 is equivalent to (exp1) AND ((exp2 AND exp3) OR (exp4))
- Available Comparators:
  - eq - Equal
  - ne - Not Equal
  - lt - Less than
  - lte - Less than or equal
  - gt - Greater than
  - gte - Greater than or equal
  - in - In (for list values)
  - nin - Not In (for list values)
  - regex - Regular Expression Match
  - iregex - Case Insensitive Regular Expression Match
- The format for in and nin which operate on arrays is:
  - [] - The list of values must be enclosed within brackets.
  - , - The value separtion token is a comma.
  - <variable>__<comp>([<value1>,<value2>])
- Examples:
  - create_time__gte(2022-01-01T13:11:02);object_class__regex(binary.*)
  - create_time__gte(2022-01-01) AND create_time__lt(2022-02-01) AND NOT match_count__gt(10)
  - create_time__gte(2022-01-01) AND create_time__lt(2022-02-01)

Responses

All responses WILL be of type APIResponse and contain the following fields:

success | Boolean value indicating if the operation succeeded.
status | Status code. Corresponds to the HTTP status code.
message | A human readable message providing more details about the operation.
links | A dictionary of name: uri links providing navigation and state-based actions on resources
errors | Array of error objects. An error object contains the following properties:
- reason | Unique identifier for this error. Ex: "FileNotFoundError".
- message| Human readable error message.
- parameter| The parameter (if any) that caused the issue.

Successful operations MUST return a SuccessResponse, which extends APIResponse by adding:

success | MUST equal True
resource | Properties containing the response object.
- (In the case of a single entity being returned)

resources | A list of response objects.
- (In the case of a list of entities being returned)

Failed Operations MUST return an ErrorResponse, which extends APIResponse by adding:

success | MUST equal False.

Common Failed Operations that you may hit on any of the endpoint operations:

400 - Bad Request - The request is malformed
401 - Unauthorized - All endpoints require authorization
403 - Forbidden - The endpoint (with the given parameters) is not available to you
404 - Not Found - The endpoint doesn't exist, or the resource being searched for doesn't exist

Example Inputs

Here are some example inputs that can be used for testing the service:

binary_id: ff9790d7902fea4c910b182f6e0b00221a40d616
proc_rva: 0x1000
search_query: ransomware

This Python package is automatically generated by the Swagger Codegen project:

API version: 2.0.0 (v2)
Package version: 2.0.5
Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://unknowncyber.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://bitbucket.org/unknowncyber/magic-clients.git@v1#egg=cythereal_magic&subdirectory=clients/python'

(you may need to run pip with root permission: sudo pip install 'git+https://bitbucket.org/unknowncyber/magic-clients.git@v1#egg=cythereal_magic&subdirectory=clients/python')

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

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)

try:
    # Adds a publicly accessible file to your account
    api_response = api_instance.add_file(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->add_file: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
tag_id = 'tag_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Associate an existing tag with a file
    api_response = api_instance.add_file_tag(binary_id, tag_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->add_file_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
payload_id = 'payload_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | Forces a payload to be added, even if one already exists (optional)

try:
    # Manually add a payload connection to a file
    api_response = api_instance.add_payload(binary_id, payload_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->add_payload: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
ids = ['ids_example'] # list[str] | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
filters = 'filters_example' # str |  Semi-colon separated string of filters. Each filter has a pattern of `(not)? <var>__<comp>(value)`   REGEX: `^(NOT\\ +)?[\\w]+__[a-z]+\\(.+\\)(\\ +(AND|OR|;)\\ +(NOT\\ +)?[\\w]+__[a-z]+\\(.+\\))*$`,  (optional)
order_by = 'order_by_example' # str |  Comma separated string containing a list of keys to sort on. Prepend with a `-` for descending.   REGEX: `^(-?[\\w]+,?)*$`  (optional)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
expand_mask = 'expand_mask_example' # str | Comma separated string containing a list of relation keys to `expand` and show the entire object inline.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)
dynamic_mask = 'dynamic_mask_example' # str | Comma separated string containing a list of dynamically created fields to return.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
action = 'action_example' # str | Used in bulk queries. Bulk queries are always POST, so 'action' allows the user to set the desired method (optional)

try:
    # Allows for actions to be carried out on bulk sets of files
    api_response = api_instance.bulk_file_operation(ids, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, filters=filters, order_by=order_by, read_mask=read_mask, expand_mask=expand_mask, dryrun=dryrun, force=force, dynamic_mask=dynamic_mask, action=action)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->bulk_file_operation: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
label = 'label_example' # str | 
source = 'source_example' # str | 
score = 56 # int | 
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Creates a new custom category label for a file
    api_response = api_instance.create_file_category(label, source, score, binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_file_category: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
label = 'label_example' # str | 
source = 'source_example' # str | 
score = 56 # int | 
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Creates a new custom family label for a file
    api_response = api_instance.create_file_family(label, source, score, binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_file_family: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
job = 'job_example' # str | The job to reprocess for this file
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | Forces a job to be run, even if previously successful (optional)

try:
    # Send a file for reprocessing
    api_response = api_instance.create_file_job(binary_id, job, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_file_job: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
note = 'note_example' # str | 
public = true # bool | 
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)

try:
    # Attaches a note to a file
    api_response = api_instance.create_file_note(note, public, binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_file_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
name = 'name_example' # str |  (optional)
color = 'color_example' # str |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)

try:
    # Create tag and bind to a file
    api_response = api_instance.create_file_tag(binary_id, name=name, color=color, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_file_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
files = ['files_example'] # list[str] | 
name = 'name_example' # str | 
unpacked = true # bool | 
config = NULL # object | 
include_all = true # bool | 
max_signatures = 56 # int | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)
strict = true # bool | Used for bulk sets of resources. If true, every resource must pass validation in order for any to be operated on (optional)

try:
    # Create Yara Rule based on multiple file hashes
    api_response = api_instance.create_files_yara(files, name, unpacked, config, include_all, max_signatures, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun, strict=strict)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_files_yara: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
note = 'note_example' # str | 
public = true # bool | 
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Attaches a note to a procedure's genomics
    api_response = api_instance.create_procedure_genomics_note(note, public, binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_procedure_genomics_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
name = 'name_example' # str | 
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)

try:
    # Attaches a tag to a procedure's genomics
    api_response = api_instance.create_procedure_genomics_tag(name, binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_procedure_genomics_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
note_id = 'note_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Deletes a specified user note attached to a file
    api_instance.delete_file_note(binary_id, note_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->delete_file_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Manually remove a payload connection from a file
    api_instance.delete_payload_relationship(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->delete_payload_relationship: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
note_id = 'note_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Removes a note from a procedure's genomics
    api_instance.delete_procedure_genomics_note(binary_id, rva, note_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->delete_procedure_genomics_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Removes a tag from a procedure's genomics
    api_instance.delete_procedure_genomics_tag(binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->delete_procedure_genomics_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
tag_id = 'tag_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Removes a tag from a procedure's genomics
    api_instance.delete_procedure_genomics_tag_by_id(binary_id, rva, tag_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->delete_procedure_genomics_tag_by_id: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'format_example' # str |  (optional)
zipped = true # bool | If true, the returned download will be in an encrypted zip file (password=infected) (optional)

try:
    # Download file
    api_instance.download_file(binary_id, format=format, zipped=zipped)
except ApiException as e:
    print("Exception when calling FilesApi->download_file: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
expand_mask = 'expand_mask_example' # str | Comma separated string containing a list of relation keys to `expand` and show the entire object inline.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
dynamic_mask = 'dynamic_mask_example' # str | Comma separated string containing a list of dynamically created fields to return.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # Retrieves information for a single file
    api_response = api_instance.get_file(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, read_mask=read_mask, expand_mask=expand_mask, dynamic_mask=dynamic_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a file's campaign information
    api_instance.get_file_campaign(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
except ApiException as e:
    print("Exception when calling FilesApi->get_file_campaign: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
note_id = 'note_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a single note attached to a file
    api_response = api_instance.get_file_note(binary_id, note_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
verbose = true # bool | Whether to include all files that infer reputation (optional)

try:
    # Retrieves the reputation status of the file
    api_response = api_instance.get_file_reputation(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, verbose=verbose)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file_reputation: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
config = 'relaxed' # str | The config of parameters to use when generating a yara rule (optional) (default to relaxed)
include_all = true # bool | Whether to include all procedures (optional)
unpacked = true # bool | Whether to use unpacked or original binaries (optional)
name = 'name_example' # str | The name of the yara rule (optional)

try:
    # Returns a yara rule for the given file
    api_response = api_instance.get_file_yara(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, config=config, include_all=include_all, unpacked=unpacked, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file_yara: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
note_id = 'note_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a note on a procedure
    api_response = api_instance.get_procedure_genomics_note(binary_id, rva, note_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_procedure_genomics_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a file's category labels
    api_response = api_instance.list_file_categories(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_categories: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Lists all files that were extracted as children
    api_response = api_instance.list_file_children(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_children: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a file's family labels
    api_response = api_instance.list_file_families(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_families: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
no_libs = true # bool | Whether to include library procedures (optional)
order_by = 'order_by_example' # str |  Comma separated string containing a list of keys to sort on. Prepend with a `-` for descending.   REGEX: `^(-?[\\w]+,?)*$`  (optional)

try:
    # Retrieves a file's genomics
    api_response = api_instance.list_file_genomics(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, read_mask=read_mask, no_libs=no_libs, order_by=order_by)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_genomics: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
malicious = true # bool | Whether to only show malicious indicators (optional) (default to true)

try:
    # Lists the Indicators of Compromise associated with a file
    api_response = api_instance.list_file_indicators(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, malicious=malicious)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_indicators: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Gets labels for a file
    api_response = api_instance.list_file_labels(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_labels: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
expand_mask = 'expand_mask_example' # str | Comma separated string containing a list of relation keys to `expand` and show the entire object inline.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
max_threshold = 3.4 # float | Only similarity matches at value equal or below max_threshold will be considered (optional)
min_threshold = 3.4 # float | Only similarity matches at value equal or above min_threshold will be considered (optional)

try:
    # Gets matches for a file
    api_response = api_instance.list_file_matches(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, read_mask=read_mask, expand_mask=expand_mask, max_threshold=max_threshold, min_threshold=min_threshold)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_matches: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves all user generated notes for file
    api_response = api_instance.list_file_notes(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_notes: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a file's parent files
    api_response = api_instance.list_file_parents(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_parents: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a procedure's genomics
    api_response = api_instance.list_file_procedure_genomics(binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_procedure_genomics: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
unpacked = true # bool | Whether to use unpacked or original binaries (optional)

try:
    # Lists all procedures and their information for the given file
    api_response = api_instance.list_file_procedures(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, read_mask=read_mask, unpacked=unpacked)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_procedures: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
max_threshold = 3.4 # float | Only similarity matches at value equal or below max_threshold will be considered (optional)
method = 'semantic_similarity' # str | Method to use to find similarities (optional) (default to semantic_similarity)
min_threshold = 3.4 # float | Only similarity matches at value equal or above min_threshold will be considered (optional)

try:
    # Retrieves similar file matches for the specified file
    api_response = api_instance.list_file_similarities(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, max_threshold=max_threshold, method=method, min_threshold=min_threshold)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_similarities: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Gets strings for a file
    api_response = api_instance.list_file_strings(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_strings: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
expand_mask = 'expand_mask_example' # str | Comma separated string containing a list of relation keys to `expand` and show the entire object inline.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # List all user tags associated with a file
    api_response = api_instance.list_file_tags(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, expand_mask=expand_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_tags: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
expand_mask = 'expand_mask_example' # str | Comma separated string containing a list of relation keys to `expand` and show the entire object inline.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    api_response = api_instance.list_file_yara_matches(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, read_mask=read_mask, expand_mask=expand_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_file_yara_matches: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
filters = 'filters_example' # str |  Semi-colon separated string of filters. Each filter has a pattern of `(not)? <var>__<comp>(value)`   REGEX: `^(NOT\\ +)?[\\w]+__[a-z]+\\(.+\\)(\\ +(AND|OR|;)\\ +(NOT\\ +)?[\\w]+__[a-z]+\\(.+\\))*$`,  (optional)
order_by = 'order_by_example' # str |  Comma separated string containing a list of keys to sort on. Prepend with a `-` for descending.   REGEX: `^(-?[\\w]+,?)*$`  (optional)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
expand_mask = 'expand_mask_example' # str | Comma separated string containing a list of relation keys to `expand` and show the entire object inline.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)
dynamic_mask = 'dynamic_mask_example' # str | Comma separated string containing a list of dynamically created fields to return.   REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # List user files based on the parameters specified
    api_response = api_instance.list_files(format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, filters=filters, order_by=order_by, read_mask=read_mask, expand_mask=expand_mask, dynamic_mask=dynamic_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_files: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a procedure genomics' notes
    api_response = api_instance.list_procedure_genomics_notes(binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_procedure_genomics_notes: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)

try:
    # Retrieves a procedure's genomics
    api_response = api_instance.list_procedure_genomics_tags(binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_procedure_genomics_tags: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)
read_mask = 'read_mask_example' # str |  Comma separated string containing a list of keys to include in the response. `*` returns all keys.  REGEX: `^(([\\w]+,?)*|\\*)$`  (optional)
max_threshold = 3.4 # float | Only similarity matches at value equal or below max_threshold will be considered (optional)
method = 'semantic_similarity' # str | Method to use to find similarities (optional) (default to semantic_similarity)
min_threshold = 3.4 # float | Only similarity matches at value equal or above min_threshold will be considered (optional)

try:
    # Retrieves similar procedures to the specified procedure
    api_response = api_instance.list_procedure_similarities(binary_id, rva, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count, read_mask=read_mask, max_threshold=max_threshold, method=method, min_threshold=min_threshold)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->list_procedure_similarities: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Removes a user's ownership from a single file
    api_instance.remove_file(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->remove_file: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
tag_id = 'tag_id_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
force = true # bool | MUST be true for any `DELETE` method to take place (optional)

try:
    # Remove an existing tag from a file
    api_instance.remove_file_tag(binary_id, tag_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)
except ApiException as e:
    print("Exception when calling FilesApi->remove_file_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
query = 'query_example' # str | Search query to look for
type = 'type_example' # str | Value type with which to search
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
page_count = 1 # int |  (optional) (default to 1)
page_size = 50 # int |  (optional) (default to 50)
skip_count = 0 # int |  (optional) (default to 0)

try:
    # Search for files based on given parameters
    api_response = api_instance.search_for_file(query, type, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, page_count=page_count, page_size=page_size, skip_count=skip_count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->search_for_file: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
public = true # bool |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
update_mask = 'update_mask_example' # str | REQUIRED for `PATCH` methods. Comma separated string containing a list of keys to update based on the request body.  REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # Updates a single file
    api_response = api_instance.update_file(binary_id, public=public, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, update_mask=update_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_file: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
note_id = 'note_id_example' # str | 
note = 'note_example' # str |  (optional)
public = true # bool |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
update_mask = 'update_mask_example' # str | REQUIRED for `PATCH` methods. Comma separated string containing a list of keys to update based on the request body.  REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    api_response = api_instance.update_file_note(binary_id, note_id, note=note, public=public, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, update_mask=update_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_file_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
procedure_name = 'procedure_name_example' # str |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
update_mask = 'update_mask_example' # str | REQUIRED for `PATCH` methods. Comma separated string containing a list of keys to update based on the request body.  REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # Edits a procedure's genomics
    api_response = api_instance.update_file_procedure_genomics(binary_id, rva, procedure_name=procedure_name, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, update_mask=update_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_file_procedure_genomics: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
tag_id = 'tag_id_example' # str | 
public = true # bool |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
update_mask = 'update_mask_example' # str | REQUIRED for `PATCH` methods. Comma separated string containing a list of keys to update based on the request body.  REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # Update a pre-existing file tag
    api_response = api_instance.update_file_tag(binary_id, tag_id, public=public, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, update_mask=update_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_file_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
note_id = 'note_id_example' # str | 
note = 'note_example' # str |  (optional)
public = true # bool |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
update_mask = 'update_mask_example' # str | REQUIRED for `PATCH` methods. Comma separated string containing a list of keys to update based on the request body.  REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # Edits a note on a procedure
    api_response = api_instance.update_procedure_genomics_note(binary_id, rva, note_id, note=note, public=public, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, update_mask=update_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_procedure_genomics_note: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
binary_id = 'binary_id_example' # str | 
rva = 'rva_example' # str | 
tag_id = 'tag_id_example' # str | 
public = true # bool |  (optional)
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
update_mask = 'update_mask_example' # str | REQUIRED for `PATCH` methods. Comma separated string containing a list of keys to update based on the request body.  REGEX: `^(([\\w]+,?)*|\\*)$` (optional)

try:
    # Updates a tag from a procedure's genomics
    api_response = api_instance.update_procedure_genomics_tag(binary_id, rva, tag_id, public=public, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, update_mask=update_mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_procedure_genomics_tag: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
filedata = 'filedata_example' # str | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)

try:
    # Upload an archive containing extracted data to be juiced
    api_response = api_instance.upload_disassembly(filedata, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->upload_disassembly: %s\n" % e)

# Configure API key authorization: Api Key Header Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure API key authorization: Api Key Query Authentication
configuration = cythereal_magic.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication
configuration = cythereal_magic.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))
filedata = ['filedata_example'] # list[str] | 
password = 'password_example' # str | 
tags = ['tags_example'] # list[str] | 
notes = ['notes_example'] # list[str] | 
format = 'json' # str | Format of the response from this endpoint (optional) (default to json)
explain = true # bool | Shows the explain for this endpoint (optional)
download = true # bool | Determines whether to download the response.(Content-Disposition:\"attachment\" vs \"inline\") (optional)
filename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\"attachment; filename=`filename`\") (optional)
no_links = true # bool | Removes the 'links' key (optional)
uri = true # bool | Use resource uri's in place of string ids (optional)
dryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)
extract = true # bool | If true, all extracted files from an archive will be top level and the archive thrown away (optional)
recursive = true # bool | If true, all archives found in the upload will be stripped and thrown (optional)
retain_wrapper = true # bool | If true with extract, then the archive will not be thrown away (optional) (default to true)
skip_unpack = true # bool | If true, Unknown Cyber's default unpacker stage will be skipped (optional)
b64 = true # bool | If true, treat the incoming filedata as a base64 encoded string (optional)
use_32 = false # bool | Whether to use 32 bit disassembly (optional) (default to false)
use_64 = false # bool | Whether to use 64 bit disassembly (optional) (default to false)

try:
    # Upload new files for processing
    api_response = api_instance.upload_file(filedata, password, tags, notes, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun, extract=extract, recursive=recursive, retain_wrapper=retain_wrapper, skip_unpack=skip_unpack, b64=b64, use_32=use_32, use_64=use_64)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->upload_file: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api:80/v2/

Class	Method	HTTP request	Description
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	create_file_tag	POST /files/{binary_id}/tags/	Create tag and bind to a file
FilesApi	create_files_yara	POST /files/yara/	Create Yara Rule based on multiple file hashes
FilesApi	create_procedure_genomics_note	POST /files/{binary_id}/genomics/{rva}/notes/	Attaches a note to a procedure's genomics
FilesApi	create_procedure_genomics_tag	POST /files/{binary_id}/genomics/{rva}/tags/	Attaches a tag to a procedure's genomics
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	delete_procedure_genomics_note	DELETE /files/{binary_id}/genomics/{rva}/notes/{note_id}/	Removes a note from a procedure's genomics
FilesApi	delete_procedure_genomics_tag	DELETE /files/{binary_id}/genomics/{rva}/tags/	Removes a tag from a procedure's genomics
FilesApi	delete_procedure_genomics_tag_by_id	DELETE /files/{binary_id}/genomics/{rva}/tags/{tag_id}/	Removes a tag from a procedure's genomics
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	get_procedure_genomics_note	GET /files/{binary_id}/genomics/{rva}/notes/{note_id}/	Retrieves a note on a procedure
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_file_yara_matches	GET /files/{binary_id}/yara/matches/
FilesApi	list_files	GET /files/	List user files based on the parameters specified
FilesApi	list_procedure_genomics_notes	GET /files/{binary_id}/genomics/{rva}/notes/	Retrieves a procedure genomics' notes
FilesApi	list_procedure_genomics_tags	GET /files/{binary_id}/genomics/{rva}/tags/	Retrieves a procedure's genomics
FilesApi	list_procedure_similarities	GET /files/{binary_id}/similarities/{rva}/	Retrieves similar procedures to the specified procedure
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	update_file_note	PATCH /files/{binary_id}/notes/{note_id}/
FilesApi	update_file_procedure_genomics	PATCH /files/{binary_id}/genomics/{rva}/	Edits a procedure's genomics
FilesApi	update_file_tag	PATCH /files/{binary_id}/tags/{tag_id}/	Update a pre-existing file tag
FilesApi	update_procedure_genomics_note	PATCH /files/{binary_id}/genomics/{rva}/notes/{note_id}/	Edits a note on a procedure
FilesApi	update_procedure_genomics_tag	PATCH /files/{binary_id}/genomics/{rva}/tags/{tag_id}/	Updates a tag from a procedure's genomics
FilesApi	upload_disassembly	POST /files/disassembly/	Upload an archive containing extracted data to be juiced
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	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	add_procedure_tag	POST /procedures/{proc_hash}/tags/	Adds a tag to a procedure
ProceduresApi	bulk_procedure_operation	POST /procedures/bulk/	Get procedures in bulk
ProceduresApi	create_procedure_note	POST /procedures/{proc_hash}/notes/	Adds a note to a procedure
ProceduresApi	create_procedures_yara	POST /procedures/yara/	Create Yara Rule based on given multiple procedures
ProceduresApi	delete_procedure_note	DELETE /procedures/{proc_hash}/notes/{note_id}/	Deletes a procedure's note
ProceduresApi	delete_procedure_tag	DELETE /procedures/{proc_hash}/tags/{tag_id}/	Deletes a procedure's tag
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_notes	GET /procedures/{proc_hash}/notes/	Lists a procedure's notes
ProceduresApi	list_procedure_similarities2	GET /procedures/{proc_hash}/similarities/	Lists a procedure's similarities
ProceduresApi	list_procedure_tags	GET /procedures/{proc_hash}/tags/	Lists a procedure's tags
ProceduresApi	list_procedures	GET /procedures/	Get all procedures
ProceduresApi	update_procedure_note	PATCH /procedures/{proc_hash}/notes/{note_id}/	Updates a note from a procedure group
ProceduresApi	update_procedure_tag	PATCH /procedures/{proc_hash}/tags/{tag_id}/	Updates a tag from a procedure group
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 a tag from all files
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/

Documentation For Models

Documentation For Authorization

Api Key Header Authentication

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header

Api Key Query Authentication

Type: API key
API key parameter name: key
Location: URL query string

Basic Authentication

Type: HTTP basic authentication

JWT Access Token Authentication

Author

support@unknowncyber.com

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-2.0.5.tar.gz (256.8 kB view details)

Uploaded Dec 15, 2023 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cythereal_magic-2.0.5-py3-none-any.whl (1.4 MB view details)

Uploaded Dec 15, 2023 Python 3

File details

Details for the file cythereal-magic-2.0.5.tar.gz.

File metadata

Download URL: cythereal-magic-2.0.5.tar.gz
Upload date: Dec 15, 2023
Size: 256.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.11.6

File hashes

Hashes for cythereal-magic-2.0.5.tar.gz
Algorithm	Hash digest
SHA256	`25dc3ef472b9e52ccd6ba8e511fffdba8f1b5bf52ea302771523e80c646a47cb`
MD5	`e2cb4d0edf1e63484df3d2ddf8500d80`
BLAKE2b-256	`229c98e0a7887d2eb336f64305342c40c4b1a15e1b5996ef312d6d0bd2445564`

See more details on using hashes here.

File details

Details for the file cythereal_magic-2.0.5-py3-none-any.whl.

File metadata

Download URL: cythereal_magic-2.0.5-py3-none-any.whl
Upload date: Dec 15, 2023
Size: 1.4 MB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.11.6

File hashes

Hashes for cythereal_magic-2.0.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`aff7523186c1c8238380d405c6328cc637a40b305995b9ed19f0a354eb0d2471`
MD5	`a363e0afc189a42114d29673f3a035cc`
BLAKE2b-256	`9d9fffc077ffefd0d9aac06ed475591d54da94aa3b970776e9796488917c71c0`

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.0.5

Dec 15, 2023

2.0.4

Dec 15, 2023

2.0.3

Dec 12, 2023

2.0.2

Nov 29, 2023

2.0.1

Nov 17, 2023

1.29.0

Apr 7, 2022

1.28.2

Feb 8, 2022

1.28.1

Feb 4, 2022

1.28.0

Feb 4, 2022

1.27.4

Jan 14, 2021

1.27.3

Jan 11, 2021

1.27.2

Jan 7, 2021

1.27.1

Dec 15, 2020

1.27.0

Dec 8, 2020

1.26.3

Dec 3, 2020

1.26.2

Dec 1, 2020

1.26.1

Nov 19, 2020

1.26.0

Nov 12, 2020

1.25.0

Oct 30, 2020

1.24.1

Oct 21, 2020

1.24.0

Oct 19, 2020

1.23.0

Oct 14, 2020

1.22.0

Oct 6, 2020

1.21.2

Oct 5, 2020

1.21.1

Apr 24, 2020

1.20.4

Apr 16, 2020

1.20.3

Apr 9, 2020

1.20.2

Apr 9, 2020

1.20.1

Apr 9, 2020

1.20.0

Apr 8, 2020

1.19.0

Jan 14, 2020

1.18.2

Jul 29, 2019

1.18.1

Jul 20, 2019

1.18.0

Jul 18, 2019

1.17.1

Jul 18, 2019

1.17.0

Jul 17, 2019

1.16.0

Feb 20, 2019

1.15.0

Feb 12, 2019

1.14.1

Jan 22, 2019

1.14.0

Jan 22, 2019

1.13.0

Jan 2, 2019

1.12.2

Jan 2, 2019

1.12.1

Dec 20, 2018

1.12.0

Dec 13, 2018

1.11.1

Dec 13, 2018

1.11.0

Dec 11, 2018

1.10.0

Dec 1, 2018

1.9.1

Sep 5, 2018

1.9.0

Sep 5, 2018

1.8.0

Sep 5, 2018

1.7.1

Sep 3, 2018

1.7.0

Aug 29, 2018

1.6.3

Aug 23, 2018

1.6.2

Aug 23, 2018

1.6.0

Aug 18, 2018

1.5.1

Aug 18, 2018

1.5.0

Aug 15, 2018

1.4.0

Aug 15, 2018

1.3.0

Aug 15, 2018

1.2.4

Jul 10, 2018

1.2.3

Jul 10, 2018

1.2.2

Jul 3, 2018

1.2.1

Jul 3, 2018

1.2.0

Jul 2, 2018

1.1.0

Jun 27, 2018

1.0.9

Feb 21, 2018

1.0.8

Feb 21, 2018

1.0.7

Jan 24, 2018

0.0.26

Nov 15, 2023

0.0.25

Nov 15, 2023

0.0.24

Nov 15, 2023

0.0.22

Nov 13, 2023

0.0.21

Nov 13, 2023

0.0.20

Nov 4, 2023

0.0.19

Jun 13, 2023

0.0.18

Jun 9, 2023

0.0.17

Jun 8, 2023

0.0.16

Jun 7, 2023

0.0.15

Jun 2, 2023

0.0.14

Apr 25, 2023

0.0.13

Apr 25, 2023

0.0.12

Apr 17, 2023

0.0.11

Apr 17, 2023

0.0.10

Apr 17, 2023

0.0.9

Apr 13, 2023

0.0.8

Apr 12, 2023

0.0.7

Apr 11, 2023

0.0.6

Apr 10, 2023

0.0.5

Apr 10, 2023

0.0.4

Apr 10, 2023

0.0.3

Apr 10, 2023

0.0.2

Apr 10, 2023

0.0.1

Apr 4, 2023

0.0.0

Apr 4, 2023

cythereal-magic 2.0.5

cythereal-magic

The API for accessing Unknown Cyber MAGIC products and services.

Authentication

Content Negotiation

Requests

GET Conventions

Possible query parameters:

POST Conventions

PATCH Conventions

Possible query parameters:

DELETE Conventions

Possible query parameters:

bulk endpoints

Possible query parameters:

Pagination:

Pagination query paramters:

Sorting:

Sorting query parameter:

Filtering:

Filters query parameter:

Responses

Example Inputs

Requirements.

Installation & Usage

pip install

Setuptools

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

Api Key Header Authentication

Api Key Query Authentication

Basic Authentication

JWT Access Token Authentication

Author

Key dates

3 maintainers

Credits

Tags

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes

Release history Release notifications | RSS feed