| Name | cythereal-magic JSON |
| Version |
2.0.5
JSON |
| download |
| home_page | |
| Summary | MAGIC™ API |
| upload_time | 2023-12-15 20:55:05 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | |
| keywords |
swagger
magic™ api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cythereal-magic
---
# The API for accessing Unknown Cyber MAGIC products and services.
---
## Authentication
**(Head to our [/auth](../auth/swagger) 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)
**OR**
* `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](https://github.com/swagger-api/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](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
```sh
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:
```python
import cythereal_magic
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import cythereal_magic
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/FilesApi.md#add_file) | **POST** /files/{binary_id}/ | Adds a publicly accessible file to your account
*FilesApi* | [**add_file_tag**](docs/FilesApi.md#add_file_tag) | **POST** /files/{binary_id}/tags/{tag_id}/ | Associate an existing tag with a file
*FilesApi* | [**add_payload**](docs/FilesApi.md#add_payload) | **POST** /files/{binary_id}/payload/{payload_id}/ | Manually add a payload connection to a file
*FilesApi* | [**bulk_file_operation**](docs/FilesApi.md#bulk_file_operation) | **POST** /files/bulk/ | Allows for actions to be carried out on bulk sets of files
*FilesApi* | [**create_file_category**](docs/FilesApi.md#create_file_category) | **POST** /files/{binary_id}/categories/ | Creates a new custom category label for a file
*FilesApi* | [**create_file_family**](docs/FilesApi.md#create_file_family) | **POST** /files/{binary_id}/families/ | Creates a new custom family label for a file
*FilesApi* | [**create_file_job**](docs/FilesApi.md#create_file_job) | **POST** /files/{binary_id}/jobs/ | Send a file for reprocessing
*FilesApi* | [**create_file_note**](docs/FilesApi.md#create_file_note) | **POST** /files/{binary_id}/notes/ | Attaches a note to a file
*FilesApi* | [**create_file_tag**](docs/FilesApi.md#create_file_tag) | **POST** /files/{binary_id}/tags/ | Create tag and bind to a file
*FilesApi* | [**create_files_yara**](docs/FilesApi.md#create_files_yara) | **POST** /files/yara/ | Create Yara Rule based on multiple file hashes
*FilesApi* | [**create_procedure_genomics_note**](docs/FilesApi.md#create_procedure_genomics_note) | **POST** /files/{binary_id}/genomics/{rva}/notes/ | Attaches a note to a procedure's genomics
*FilesApi* | [**create_procedure_genomics_tag**](docs/FilesApi.md#create_procedure_genomics_tag) | **POST** /files/{binary_id}/genomics/{rva}/tags/ | Attaches a tag to a procedure's genomics
*FilesApi* | [**delete_file_note**](docs/FilesApi.md#delete_file_note) | **DELETE** /files/{binary_id}/notes/{note_id}/ | Deletes a specified user note attached to a file
*FilesApi* | [**delete_payload_relationship**](docs/FilesApi.md#delete_payload_relationship) | **DELETE** /files/{binary_id}/payload/ | Manually remove a payload connection from a file
*FilesApi* | [**delete_procedure_genomics_note**](docs/FilesApi.md#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**](docs/FilesApi.md#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**](docs/FilesApi.md#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**](docs/FilesApi.md#download_file) | **GET** /files/{binary_id}/download/ | Download file
*FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /files/{binary_id}/ | Retrieves information for a single file
*FilesApi* | [**get_file_campaign**](docs/FilesApi.md#get_file_campaign) | **GET** /files/{binary_id}/campaign/ | Retrieves a file's campaign information
*FilesApi* | [**get_file_note**](docs/FilesApi.md#get_file_note) | **GET** /files/{binary_id}/notes/{note_id}/ | Retrieves a single note attached to a file
*FilesApi* | [**get_file_reputation**](docs/FilesApi.md#get_file_reputation) | **GET** /files/{binary_id}/reputation/ | Retrieves the reputation status of the file
*FilesApi* | [**get_file_yara**](docs/FilesApi.md#get_file_yara) | **GET** /files/{binary_id}/yara/ | Returns a yara rule for the given file
*FilesApi* | [**get_procedure_genomics_note**](docs/FilesApi.md#get_procedure_genomics_note) | **GET** /files/{binary_id}/genomics/{rva}/notes/{note_id}/ | Retrieves a note on a procedure
*FilesApi* | [**list_file_categories**](docs/FilesApi.md#list_file_categories) | **GET** /files/{binary_id}/categories/ | Retrieves a file's category labels
*FilesApi* | [**list_file_children**](docs/FilesApi.md#list_file_children) | **GET** /files/{binary_id}/children/ | Lists all files that were extracted as children
*FilesApi* | [**list_file_families**](docs/FilesApi.md#list_file_families) | **GET** /files/{binary_id}/families/ | Retrieves a file's family labels
*FilesApi* | [**list_file_genomics**](docs/FilesApi.md#list_file_genomics) | **GET** /files/{binary_id}/genomics/ | Retrieves a file's genomics
*FilesApi* | [**list_file_indicators**](docs/FilesApi.md#list_file_indicators) | **GET** /files/{binary_id}/indicators/ | Lists the Indicators of Compromise associated with a file
*FilesApi* | [**list_file_labels**](docs/FilesApi.md#list_file_labels) | **GET** /files/{binary_id}/labels/ | Gets labels for a file
*FilesApi* | [**list_file_matches**](docs/FilesApi.md#list_file_matches) | **GET** /files/{binary_id}/matches/ | Gets matches for a file
*FilesApi* | [**list_file_notes**](docs/FilesApi.md#list_file_notes) | **GET** /files/{binary_id}/notes/ | Retrieves all user generated notes for file
*FilesApi* | [**list_file_parents**](docs/FilesApi.md#list_file_parents) | **GET** /files/{binary_id}/parents/ | Retrieves a file's parent files
*FilesApi* | [**list_file_procedure_genomics**](docs/FilesApi.md#list_file_procedure_genomics) | **GET** /files/{binary_id}/genomics/{rva}/ | Retrieves a procedure's genomics
*FilesApi* | [**list_file_procedures**](docs/FilesApi.md#list_file_procedures) | **GET** /files/{binary_id}/procedures/ | Lists all procedures and their information for the given file
*FilesApi* | [**list_file_similarities**](docs/FilesApi.md#list_file_similarities) | **GET** /files/{binary_id}/similarities/ | Retrieves similar file matches for the specified file
*FilesApi* | [**list_file_strings**](docs/FilesApi.md#list_file_strings) | **GET** /files/{binary_id}/strings/ | Gets strings for a file
*FilesApi* | [**list_file_tags**](docs/FilesApi.md#list_file_tags) | **GET** /files/{binary_id}/tags/ | List all user tags associated with a file
*FilesApi* | [**list_file_yara_matches**](docs/FilesApi.md#list_file_yara_matches) | **GET** /files/{binary_id}/yara/matches/ |
*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /files/ | List user files based on the parameters specified
*FilesApi* | [**list_procedure_genomics_notes**](docs/FilesApi.md#list_procedure_genomics_notes) | **GET** /files/{binary_id}/genomics/{rva}/notes/ | Retrieves a procedure genomics' notes
*FilesApi* | [**list_procedure_genomics_tags**](docs/FilesApi.md#list_procedure_genomics_tags) | **GET** /files/{binary_id}/genomics/{rva}/tags/ | Retrieves a procedure's genomics
*FilesApi* | [**list_procedure_similarities**](docs/FilesApi.md#list_procedure_similarities) | **GET** /files/{binary_id}/similarities/{rva}/ | Retrieves similar procedures to the specified procedure
*FilesApi* | [**remove_file**](docs/FilesApi.md#remove_file) | **DELETE** /files/{binary_id}/ | Removes a user's ownership from a single file
*FilesApi* | [**remove_file_tag**](docs/FilesApi.md#remove_file_tag) | **DELETE** /files/{binary_id}/tags/{tag_id}/ | Remove an existing tag from a file
*FilesApi* | [**search_for_file**](docs/FilesApi.md#search_for_file) | **GET** /files/search/ | Search for files based on given parameters
*FilesApi* | [**update_file**](docs/FilesApi.md#update_file) | **PATCH** /files/{binary_id}/ | Updates a single file
*FilesApi* | [**update_file_note**](docs/FilesApi.md#update_file_note) | **PATCH** /files/{binary_id}/notes/{note_id}/ |
*FilesApi* | [**update_file_procedure_genomics**](docs/FilesApi.md#update_file_procedure_genomics) | **PATCH** /files/{binary_id}/genomics/{rva}/ | Edits a procedure's genomics
*FilesApi* | [**update_file_tag**](docs/FilesApi.md#update_file_tag) | **PATCH** /files/{binary_id}/tags/{tag_id}/ | Update a pre-existing file tag
*FilesApi* | [**update_procedure_genomics_note**](docs/FilesApi.md#update_procedure_genomics_note) | **PATCH** /files/{binary_id}/genomics/{rva}/notes/{note_id}/ | Edits a note on a procedure
*FilesApi* | [**update_procedure_genomics_tag**](docs/FilesApi.md#update_procedure_genomics_tag) | **PATCH** /files/{binary_id}/genomics/{rva}/tags/{tag_id}/ | Updates a tag from a procedure's genomics
*FilesApi* | [**upload_disassembly**](docs/FilesApi.md#upload_disassembly) | **POST** /files/disassembly/ | Upload an archive containing extracted data to be juiced
*FilesApi* | [**upload_file**](docs/FilesApi.md#upload_file) | **POST** /files/ | Upload new files for processing
*GenomicsApi* | [**compare_files**](docs/GenomicsApi.md#compare_files) | **GET** /genomics/compare/ | Takes in a list of files and sends back comparison results (slow)
*GroupsApi* | [**add_member**](docs/GroupsApi.md#add_member) | **POST** /groups/{id}/members/{member_id}/ | Adds the `member_id` user to the `id` group
*GroupsApi* | [**add_new_member**](docs/GroupsApi.md#add_new_member) | **POST** /groups/{id}/members/ | Adds the given user to this group
*GroupsApi* | [**bulk_group_operation**](docs/GroupsApi.md#bulk_group_operation) | **POST** /groups/bulk/ | Bulk operations on Group resources
*GroupsApi* | [**create_group**](docs/GroupsApi.md#create_group) | **POST** /groups/ | Create a new group
*GroupsApi* | [**delete_group**](docs/GroupsApi.md#delete_group) | **DELETE** /groups/{id}/ | Deletes a group
*GroupsApi* | [**get_group**](docs/GroupsApi.md#get_group) | **GET** /groups/{id}/ | Retrieves detailed information on a single group
*GroupsApi* | [**get_member**](docs/GroupsApi.md#get_member) | **GET** /groups/{id}/members/{member_id}/ | Returns the user with `member_id` with their `id` group settings
*GroupsApi* | [**group_login**](docs/GroupsApi.md#group_login) | **GET** /groups/{id}/login/ | Returns a jwt Token for this group
*GroupsApi* | [**group_logout**](docs/GroupsApi.md#group_logout) | **GET** /groups/logout/ | Converts the group jwt back into a single user jwt
*GroupsApi* | [**list_groups**](docs/GroupsApi.md#list_groups) | **GET** /groups/ | List all accessible groups
*GroupsApi* | [**list_members**](docs/GroupsApi.md#list_members) | **GET** /groups/{id}/members/ | List all members of a group
*GroupsApi* | [**remove_member**](docs/GroupsApi.md#remove_member) | **DELETE** /groups/{id}/members/{member_id}/ | Removes the `member_id` user from the `id` group
*GroupsApi* | [**update_group**](docs/GroupsApi.md#update_group) | **PATCH** /groups/{id}/ | Updates a group
*GroupsApi* | [**update_member**](docs/GroupsApi.md#update_member) | **PATCH** /groups/{id}/members/{member_id}/ | Updates the `member_id` user in the `id` group
*IndicatorsApi* | [**list_iocs**](docs/IndicatorsApi.md#list_iocs) | **GET** /indicators/ | Lists all indicators associated with a user account
*IndicatorsApi* | [**upload_ioc_file**](docs/IndicatorsApi.md#upload_ioc_file) | **POST** /indicators/files/ | Upload a text or csv file for IoC Extraction
*ProceduresApi* | [**add_procedure_tag**](docs/ProceduresApi.md#add_procedure_tag) | **POST** /procedures/{proc_hash}/tags/ | Adds a tag to a procedure
*ProceduresApi* | [**bulk_procedure_operation**](docs/ProceduresApi.md#bulk_procedure_operation) | **POST** /procedures/bulk/ | Get procedures in bulk
*ProceduresApi* | [**create_procedure_note**](docs/ProceduresApi.md#create_procedure_note) | **POST** /procedures/{proc_hash}/notes/ | Adds a note to a procedure
*ProceduresApi* | [**create_procedures_yara**](docs/ProceduresApi.md#create_procedures_yara) | **POST** /procedures/yara/ | Create Yara Rule based on given multiple procedures
*ProceduresApi* | [**delete_procedure_note**](docs/ProceduresApi.md#delete_procedure_note) | **DELETE** /procedures/{proc_hash}/notes/{note_id}/ | Deletes a procedure's note
*ProceduresApi* | [**delete_procedure_tag**](docs/ProceduresApi.md#delete_procedure_tag) | **DELETE** /procedures/{proc_hash}/tags/{tag_id}/ | Deletes a procedure's tag
*ProceduresApi* | [**get_procedure**](docs/ProceduresApi.md#get_procedure) | **GET** /procedures/{proc_hash}/ | Get a single procedure
*ProceduresApi* | [**list_procedure_files**](docs/ProceduresApi.md#list_procedure_files) | **GET** /procedures/{proc_hash}/files/ | Retrieves a procedure's files
*ProceduresApi* | [**list_procedure_notes**](docs/ProceduresApi.md#list_procedure_notes) | **GET** /procedures/{proc_hash}/notes/ | Lists a procedure's notes
*ProceduresApi* | [**list_procedure_similarities2**](docs/ProceduresApi.md#list_procedure_similarities2) | **GET** /procedures/{proc_hash}/similarities/ | Lists a procedure's similarities
*ProceduresApi* | [**list_procedure_tags**](docs/ProceduresApi.md#list_procedure_tags) | **GET** /procedures/{proc_hash}/tags/ | Lists a procedure's tags
*ProceduresApi* | [**list_procedures**](docs/ProceduresApi.md#list_procedures) | **GET** /procedures/ | Get all procedures
*ProceduresApi* | [**update_procedure_note**](docs/ProceduresApi.md#update_procedure_note) | **PATCH** /procedures/{proc_hash}/notes/{note_id}/ | Updates a note from a procedure group
*ProceduresApi* | [**update_procedure_tag**](docs/ProceduresApi.md#update_procedure_tag) | **PATCH** /procedures/{proc_hash}/tags/{tag_id}/ | Updates a tag from a procedure group
*ReportsApi* | [**get_archive_report**](docs/ReportsApi.md#get_archive_report) | **GET** /reports/{binary_id}/archive/ | Retrieves the report info of a container like file
*ReportsApi* | [**get_report_features**](docs/ReportsApi.md#get_report_features) | **GET** /reports/{binary_id}/features/ | Retrieves the genomic features of a file
*SearchApi* | [**count_search_results**](docs/SearchApi.md#count_search_results) | **GET** /search/count/ | Returns total count of results via search
*SearchApi* | [**search_files**](docs/SearchApi.md#search_files) | **GET** /search/ | Returns files found via search
*SupportApi* | [**report_bug**](docs/SupportApi.md#report_bug) | **POST** /support/bug/ | Allows users to report a bug within the system
*TagsApi* | [**bulk_tag_operation**](docs/TagsApi.md#bulk_tag_operation) | **POST** /tags/bulk/ | Lists information on a bulk selection of tags
*TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /tags/ | Create a new Project for tagging files
*TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /tags/{id}/ | Deletes a tag
*TagsApi* | [**delete_tags**](docs/TagsApi.md#delete_tags) | **DELETE** /tags/ | Delete tags in your collection
*TagsApi* | [**get_tag**](docs/TagsApi.md#get_tag) | **GET** /tags/{id}/ | Retrieves detailed information on a single tag
*TagsApi* | [**list_tagged_files**](docs/TagsApi.md#list_tagged_files) | **GET** /tags/{id}/files/ | Lists all files associated with this tag
*TagsApi* | [**list_tags**](docs/TagsApi.md#list_tags) | **GET** /tags/ | List all tags
*TagsApi* | [**remove_tags**](docs/TagsApi.md#remove_tags) | **DELETE** /tags/{id}/files/ | Removes a tag from all files
*TagsApi* | [**update_tag**](docs/TagsApi.md#update_tag) | **PATCH** /tags/{id}/ | Updates a tag
*TagsApi* | [**update_tags**](docs/TagsApi.md#update_tags) | **PATCH** /tags/ | Updates all tags in your collection
*UsersApi* | [**deactivate_account**](docs/UsersApi.md#deactivate_account) | **DELETE** /users/me/ | Deactivate your account
*UsersApi* | [**get_account**](docs/UsersApi.md#get_account) | **GET** /users/me/ | Retrieve your account information
*UsersApi* | [**get_my_group**](docs/UsersApi.md#get_my_group) | **GET** /users/me/groups/{id}/ | Retrieve info for a group
*UsersApi* | [**leave_my_group**](docs/UsersApi.md#leave_my_group) | **DELETE** /users/me/groups/{id}/ | Leave group
*UsersApi* | [**leave_my_groups**](docs/UsersApi.md#leave_my_groups) | **DELETE** /users/me/groups/ | Leave all groups
*UsersApi* | [**list_my_groups**](docs/UsersApi.md#list_my_groups) | **GET** /users/me/groups/ | Lists your groups
*UsersApi* | [**update_account**](docs/UsersApi.md#update_account) | **PATCH** /users/me/ | Update your account information
*YaraApi* | [**create_yara**](docs/YaraApi.md#create_yara) | **POST** /yara/ | Create Yara Rule based on specific file hashes
*YaraApi* | [**yara_procedure_matches**](docs/YaraApi.md#yara_procedure_matches) | **GET** /yara/{binary_id}/matches/ |
## Documentation For Models
- [AllOfDirectReputationReputation](docs/AllOfDirectReputationReputation.md)
- [AllOfFileAvscan](docs/AllOfFileAvscan.md)
- [AllOfFileCampaign](docs/AllOfFileCampaign.md)
- [AllOfFileCategories](docs/AllOfFileCategories.md)
- [AllOfFileChildAvscan](docs/AllOfFileChildAvscan.md)
- [AllOfFileChildCampaign](docs/AllOfFileChildCampaign.md)
- [AllOfFileChildCategories](docs/AllOfFileChildCategories.md)
- [AllOfFileChildFamilies](docs/AllOfFileChildFamilies.md)
- [AllOfFileChildLabels](docs/AllOfFileChildLabels.md)
- [AllOfFileChildMatches](docs/AllOfFileChildMatches.md)
- [AllOfFileChildNotes](docs/AllOfFileChildNotes.md)
- [AllOfFileChildPipeline](docs/AllOfFileChildPipeline.md)
- [AllOfFileChildReputation](docs/AllOfFileChildReputation.md)
- [AllOfFileChildUnmapped](docs/AllOfFileChildUnmapped.md)
- [AllOfFileChildren](docs/AllOfFileChildren.md)
- [AllOfFileFamilies](docs/AllOfFileFamilies.md)
- [AllOfFileLabels](docs/AllOfFileLabels.md)
- [AllOfFileMatchResponseAvscan](docs/AllOfFileMatchResponseAvscan.md)
- [AllOfFileMatchResponseCampaign](docs/AllOfFileMatchResponseCampaign.md)
- [AllOfFileMatchResponseCategories](docs/AllOfFileMatchResponseCategories.md)
- [AllOfFileMatchResponseChildren](docs/AllOfFileMatchResponseChildren.md)
- [AllOfFileMatchResponseFamilies](docs/AllOfFileMatchResponseFamilies.md)
- [AllOfFileMatchResponseLabels](docs/AllOfFileMatchResponseLabels.md)
- [AllOfFileMatchResponseMatchType](docs/AllOfFileMatchResponseMatchType.md)
- [AllOfFileMatchResponseMatches](docs/AllOfFileMatchResponseMatches.md)
- [AllOfFileMatchResponseNotes](docs/AllOfFileMatchResponseNotes.md)
- [AllOfFileMatchResponsePipeline](docs/AllOfFileMatchResponsePipeline.md)
- [AllOfFileMatchResponseReputation](docs/AllOfFileMatchResponseReputation.md)
- [AllOfFileMatchResponseUnmapped](docs/AllOfFileMatchResponseUnmapped.md)
- [AllOfFileMatches](docs/AllOfFileMatches.md)
- [AllOfFileNotes](docs/AllOfFileNotes.md)
- [AllOfFilePipeline](docs/AllOfFilePipeline.md)
- [AllOfFilePipelineAltJuiceHandler](docs/AllOfFilePipelineAltJuiceHandler.md)
- [AllOfFilePipelineDashboardCampaign](docs/AllOfFilePipelineDashboardCampaign.md)
- [AllOfFilePipelineDashboardReport](docs/AllOfFilePipelineDashboardReport.md)
- [AllOfFilePipelineIocHandler](docs/AllOfFilePipelineIocHandler.md)
- [AllOfFilePipelineProcHashSignatures](docs/AllOfFilePipelineProcHashSignatures.md)
- [AllOfFilePipelineSimilarityComputation](docs/AllOfFilePipelineSimilarityComputation.md)
- [AllOfFilePipelineSrlJuice](docs/AllOfFilePipelineSrlJuice.md)
- [AllOfFilePipelineSrlScanners](docs/AllOfFilePipelineSrlScanners.md)
- [AllOfFilePipelineSrlUnpacker](docs/AllOfFilePipelineSrlUnpacker.md)
- [AllOfFilePipelineVariantHashSignatures](docs/AllOfFilePipelineVariantHashSignatures.md)
- [AllOfFilePipelineWebRequestHandler](docs/AllOfFilePipelineWebRequestHandler.md)
- [AllOfFileReputation](docs/AllOfFileReputation.md)
- [AllOfFileReputationInferredReputation](docs/AllOfFileReputationInferredReputation.md)
- [AllOfFileReputationReputation](docs/AllOfFileReputationReputation.md)
- [AllOfFileUnmapped](docs/AllOfFileUnmapped.md)
- [AllOfGroupAdmins](docs/AllOfGroupAdmins.md)
- [AllOfGroupMembers](docs/AllOfGroupMembers.md)
- [AllOfGroupReducedResponseAdmins](docs/AllOfGroupReducedResponseAdmins.md)
- [AllOfGroupReducedResponseMembers](docs/AllOfGroupReducedResponseMembers.md)
- [AllOfInferredReputationCriteria](docs/AllOfInferredReputationCriteria.md)
- [AllOfInferredReputationReputation](docs/AllOfInferredReputationReputation.md)
- [AllOfMatchMatchType](docs/AllOfMatchMatchType.md)
- [AllOfMatchSubtypeMatchSubtype](docs/AllOfMatchSubtypeMatchSubtype.md)
- [AllOfYaraProcedureRequestCondition](docs/AllOfYaraProcedureRequestCondition.md)
- [AllOfYaraRequestConfig](docs/AllOfYaraRequestConfig.md)
- [AvScanResult](docs/AvScanResult.md)
- [BadRequestResponse](docs/BadRequestResponse.md)
- [Block](docs/Block.md)
- [BlockEA](docs/BlockEA.md)
- [BlockSchema](docs/BlockSchema.md)
- [BulkGroupRequest](docs/BulkGroupRequest.md)
- [BulkProcedureRequest](docs/BulkProcedureRequest.md)
- [BulkProcedureResponse](docs/BulkProcedureResponse.md)
- [BulkRequest](docs/BulkRequest.md)
- [BulkTagRequest](docs/BulkTagRequest.md)
- [ChildResponse](docs/ChildResponse.md)
- [ChildResponseIdList](docs/ChildResponseIdList.md)
- [ConditionEnum](docs/ConditionEnum.md)
- [ConfigEnum](docs/ConfigEnum.md)
- [CriteriaEnum](docs/CriteriaEnum.md)
- [DirectReputation](docs/DirectReputation.md)
- [EnvelopedBulkProcedureResponseList200](docs/EnvelopedBulkProcedureResponseList200.md)
- [EnvelopedEmpty201](docs/EnvelopedEmpty201.md)
- [EnvelopedFile200](docs/EnvelopedFile200.md)
- [EnvelopedFileChildList200](docs/EnvelopedFileChildList200.md)
- [EnvelopedFileGenomicsResponse200](docs/EnvelopedFileGenomicsResponse200.md)
- [EnvelopedFileIndicatorResponseList200](docs/EnvelopedFileIndicatorResponseList200.md)
- [EnvelopedFileLabelCreateResponse201](docs/EnvelopedFileLabelCreateResponse201.md)
- [EnvelopedFileLabelsList200](docs/EnvelopedFileLabelsList200.md)
- [EnvelopedFileList200](docs/EnvelopedFileList200.md)
- [EnvelopedFileList200EnvelopedFileChildList200](docs/EnvelopedFileList200EnvelopedFileChildList200.md)
- [EnvelopedFileList200EnvelopedIdList200](docs/EnvelopedFileList200EnvelopedIdList200.md)
- [EnvelopedFileMatchResponseList200](docs/EnvelopedFileMatchResponseList200.md)
- [EnvelopedFileMatchResponseList200EnvelopedIdList200](docs/EnvelopedFileMatchResponseList200EnvelopedIdList200.md)
- [EnvelopedFileProcedureResponseList200](docs/EnvelopedFileProcedureResponseList200.md)
- [EnvelopedFileReputationResponse200](docs/EnvelopedFileReputationResponse200.md)
- [EnvelopedFileResponse200](docs/EnvelopedFileResponse200.md)
- [EnvelopedFileResponse201](docs/EnvelopedFileResponse201.md)
- [EnvelopedFileResponseList200](docs/EnvelopedFileResponseList200.md)
- [EnvelopedFileSearchResponseList200](docs/EnvelopedFileSearchResponseList200.md)
- [EnvelopedFileSimilarityResponseList200](docs/EnvelopedFileSimilarityResponseList200.md)
- [EnvelopedFileStringsResponseList200](docs/EnvelopedFileStringsResponseList200.md)
- [EnvelopedFileUpdateResponse206](docs/EnvelopedFileUpdateResponse206.md)
- [EnvelopedFileUploadResponse200](docs/EnvelopedFileUploadResponse200.md)
- [EnvelopedFileUploadResponse201](docs/EnvelopedFileUploadResponse201.md)
- [EnvelopedFileUploadResponseList200](docs/EnvelopedFileUploadResponseList200.md)
- [EnvelopedFileUploadResponseList201](docs/EnvelopedFileUploadResponseList201.md)
- [EnvelopedGroup200](docs/EnvelopedGroup200.md)
- [EnvelopedGroupCreatedResponse201](docs/EnvelopedGroupCreatedResponse201.md)
- [EnvelopedGroupJwtResponse200](docs/EnvelopedGroupJwtResponse200.md)
- [EnvelopedGroupList200](docs/EnvelopedGroupList200.md)
- [EnvelopedGroupReducedResponseList200](docs/EnvelopedGroupReducedResponseList200.md)
- [EnvelopedIdList200](docs/EnvelopedIdList200.md)
- [EnvelopedIdList201](docs/EnvelopedIdList201.md)
- [EnvelopedIndicatorFileUploadResponse200](docs/EnvelopedIndicatorFileUploadResponse200.md)
- [EnvelopedIndicatorResponseList200](docs/EnvelopedIndicatorResponseList200.md)
- [EnvelopedJobResponse201](docs/EnvelopedJobResponse201.md)
- [EnvelopedMapping200](docs/EnvelopedMapping200.md)
- [EnvelopedNamelessNoteList200](docs/EnvelopedNamelessNoteList200.md)
- [EnvelopedNamelessNoteList200EnvelopedIdList200](docs/EnvelopedNamelessNoteList200EnvelopedIdList200.md)
- [EnvelopedNote200](docs/EnvelopedNote200.md)
- [EnvelopedNote201](docs/EnvelopedNote201.md)
- [EnvelopedNoteList200](docs/EnvelopedNoteList200.md)
- [EnvelopedPayloadCreateResponse201](docs/EnvelopedPayloadCreateResponse201.md)
- [EnvelopedProcedureGroup200](docs/EnvelopedProcedureGroup200.md)
- [EnvelopedProcedureList200](docs/EnvelopedProcedureList200.md)
- [EnvelopedProcedureResponse200](docs/EnvelopedProcedureResponse200.md)
- [EnvelopedProcedureSimilarityResponse200](docs/EnvelopedProcedureSimilarityResponse200.md)
- [EnvelopedSearchCountResponseList200](docs/EnvelopedSearchCountResponseList200.md)
- [EnvelopedSearchResponseList200](docs/EnvelopedSearchResponseList200.md)
- [EnvelopedTag200](docs/EnvelopedTag200.md)
- [EnvelopedTagCreatedResponse200](docs/EnvelopedTagCreatedResponse200.md)
- [EnvelopedTagCreatedResponse201](docs/EnvelopedTagCreatedResponse201.md)
- [EnvelopedTagList200](docs/EnvelopedTagList200.md)
- [EnvelopedTagList200EnvelopedIdList200](docs/EnvelopedTagList200EnvelopedIdList200.md)
- [EnvelopedTagResponseList200](docs/EnvelopedTagResponseList200.md)
- [EnvelopedUser200](docs/EnvelopedUser200.md)
- [EnvelopedUserId201](docs/EnvelopedUserId201.md)
- [EnvelopedUserList200](docs/EnvelopedUserList200.md)
- [EnvelopedYara200](docs/EnvelopedYara200.md)
- [EnvelopedYaraProcedure200](docs/EnvelopedYaraProcedure200.md)
- [ErrorObject](docs/ErrorObject.md)
- [ExtendedProcedureResponse](docs/ExtendedProcedureResponse.md)
- [File](docs/File.md)
- [FileAddLabelRequest](docs/FileAddLabelRequest.md)
- [FileAvscan](docs/FileAvscan.md)
- [FileCampaign](docs/FileCampaign.md)
- [FileChild](docs/FileChild.md)
- [FileGenomicsResponse](docs/FileGenomicsResponse.md)
- [FileIdalessUploadRequest](docs/FileIdalessUploadRequest.md)
- [FileIndicator](docs/FileIndicator.md)
- [FileIndicatorResponse](docs/FileIndicatorResponse.md)
- [FileLabelCreateResponse](docs/FileLabelCreateResponse.md)
- [FileLabels](docs/FileLabels.md)
- [FileMatchResponse](docs/FileMatchResponse.md)
- [FileMatchesIdList](docs/FileMatchesIdList.md)
- [FileNote](docs/FileNote.md)
- [FileNoteIdList](docs/FileNoteIdList.md)
- [FilePipeline](docs/FilePipeline.md)
- [FileProcedureResponse](docs/FileProcedureResponse.md)
- [FileProcedures](docs/FileProcedures.md)
- [FileReputation](docs/FileReputation.md)
- [FileReputationResponse](docs/FileReputationResponse.md)
- [FileResponse](docs/FileResponse.md)
- [FileSearchResponse](docs/FileSearchResponse.md)
- [FileSimilarityObject](docs/FileSimilarityObject.md)
- [FileSimilarityResponse](docs/FileSimilarityResponse.md)
- [FileStringsResponse](docs/FileStringsResponse.md)
- [FileUpdateResponse](docs/FileUpdateResponse.md)
- [FileUploadRequest](docs/FileUploadRequest.md)
- [FileUploadResponse](docs/FileUploadResponse.md)
- [ForbiddenResponse](docs/ForbiddenResponse.md)
- [Group](docs/Group.md)
- [GroupCreatedResponse](docs/GroupCreatedResponse.md)
- [GroupJwtResponse](docs/GroupJwtResponse.md)
- [GroupReducedResponse](docs/GroupReducedResponse.md)
- [GroupRequest](docs/GroupRequest.md)
- [HashSchema](docs/HashSchema.md)
- [IndicatorFileUploadResponse](docs/IndicatorFileUploadResponse.md)
- [IndicatorResponse](docs/IndicatorResponse.md)
- [InferredData](docs/InferredData.md)
- [InferredReputation](docs/InferredReputation.md)
- [InferredReputationEnum](docs/InferredReputationEnum.md)
- [JobResponse](docs/JobResponse.md)
- [LabelSchema](docs/LabelSchema.md)
- [Mapping](docs/Mapping.md)
- [Match](docs/Match.md)
- [MatchSubtype](docs/MatchSubtype.md)
- [MatchSubtypeEnum](docs/MatchSubtypeEnum.md)
- [MatchTypeEnum](docs/MatchTypeEnum.md)
- [MiniUser](docs/MiniUser.md)
- [MiniUserIdList](docs/MiniUserIdList.md)
- [NameRequest](docs/NameRequest.md)
- [NamelessNote](docs/NamelessNote.md)
- [NotFoundResponse](docs/NotFoundResponse.md)
- [Note](docs/Note.md)
- [NoteRequest](docs/NoteRequest.md)
- [PatchedFileUpdateRequest](docs/PatchedFileUpdateRequest.md)
- [PatchedGroupUpdateRequest](docs/PatchedGroupUpdateRequest.md)
- [PatchedMemberUpdateRequest](docs/PatchedMemberUpdateRequest.md)
- [PatchedNoteRequest](docs/PatchedNoteRequest.md)
- [PatchedPublicRequest](docs/PatchedPublicRequest.md)
- [PatchedTagColorRequest](docs/PatchedTagColorRequest.md)
- [PatchedTagRequest](docs/PatchedTagRequest.md)
- [PatchedUpdateProcedureGenomicRequest](docs/PatchedUpdateProcedureGenomicRequest.md)
- [PatchedUserUpdateRequest](docs/PatchedUserUpdateRequest.md)
- [PayloadCreateResponse](docs/PayloadCreateResponse.md)
- [PipelineStatusEnum](docs/PipelineStatusEnum.md)
- [Procedure](docs/Procedure.md)
- [ProcedureBlock](docs/ProcedureBlock.md)
- [ProcedureGroup](docs/ProcedureGroup.md)
- [ProcedureResponse](docs/ProcedureResponse.md)
- [ProcedureSimilarityItem](docs/ProcedureSimilarityItem.md)
- [ProcedureSimilarityResponse](docs/ProcedureSimilarityResponse.md)
- [RepData](docs/RepData.md)
- [SearchCountResponse](docs/SearchCountResponse.md)
- [SearchResponse](docs/SearchResponse.md)
- [Tag](docs/Tag.md)
- [TagCreatedResponse](docs/TagCreatedResponse.md)
- [TagRequest](docs/TagRequest.md)
- [TagResponse](docs/TagResponse.md)
- [TaggedItem](docs/TaggedItem.md)
- [UnauthenticatedResponse](docs/UnauthenticatedResponse.md)
- [UploadIocFileRequest](docs/UploadIocFileRequest.md)
- [UploadTimesChild](docs/UploadTimesChild.md)
- [User](docs/User.md)
- [UserId](docs/UserId.md)
- [UserIdRequest](docs/UserIdRequest.md)
- [Yara](docs/Yara.md)
- [YaraProcedure](docs/YaraProcedure.md)
- [YaraProcedureRequest](docs/YaraProcedureRequest.md)
- [YaraRequest](docs/YaraRequest.md)
## 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
Raw data
{
"_id": null,
"home_page": "",
"name": "cythereal-magic",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Swagger,MAGIC\u2122 API",
"author": "",
"author_email": "support@unknowncyber.com",
"download_url": "https://files.pythonhosted.org/packages/22/9c/98e0a7887d2eb336f64305342c40c4b1a15e1b5996ef312d6d0bd2445564/cythereal-magic-2.0.5.tar.gz",
"platform": null,
"description": "# cythereal-magic\n\n---\n# The API for accessing Unknown Cyber MAGIC products and services.\n\n---\n\n## Authentication\n **(Head to our [/auth](../auth/swagger) api to register, login, or generate a token)**\n\nSupported Authentication Schemes:\n\n * HTTP Basic Authentication\n * API-KEY in the `X-API-KEY` request header\n * JWT token in the `Authorization:\"Bearer {token}\"` request header\n\n---\n\n## Content Negotiation\n\n There are two ways to specify the content type of the response. In order of precedence:\n\n * The **Accept** request header can be set with the desired mime type. The most specific version will prevail. i.e. *application/json* > *application/\\**.\n\n *Accept:\"application/json\"*\n\n * The **format** query parameter. (MUST be in lower case)\n\n *?format=json*\n\n Supported Formats:\n\n | query parameter | Accept Header | |\n |-----------------|--------------------------|---------|\n | **json** | application/json | Default |\n | **xml** | application/xml | |\n | **csv** | text/csv | |\n | **txt** | text/plain | |\n | **explain** | application/explain+json | Custom type that returns a description of usage of the endpoint |\n\n---\n## Requests\n\nSupported HTTP Methods:\n\n * **GET**\n * **POST**\n * **PATCH**\n * **DELETE**\n * **HEAD**\n * **OPTIONS**\n\nEvery request supports the following query parameters:\n\n * **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\n\n * **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.\n\n * **filename** - (str) - The filename to use for a downloaded file. Ignored if no file is being downloaded.\n\n * **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:\n\n * **json** - (application/json)\n * **xml** - (application/xml)\n * **csv** - (text/csv)\n * **txt** - (text/plain)\n * **explain** - (application/explain+json)\n * Custom type that returns a description of usage of the endpoint\n\n * **no_links** - (bool) - If set to a truthy value, links will be disabled from the response\n\n * **uri** - (bool) - If set to a truthy value, id lists will be returned as uris instead of id strings.\n\n---\n\n## GET Conventions\n### Possible query parameters:\n **(Check each endpoint description, or use *explain*, for a list of available values for each parameter)**\n\n * **read_mask** - A list of values (keys) to return for the resource or each resource within the list\n * Comma separated string of variables\n * Leaving this field blank will return the default values.\n * Setting this value equal to **`*`** will include **ALL** possible keys.\n * Traversal is allowed with the **`.`** operator.\n * There are three special keys that can be used with all endponts\n * **`*`** - This will return all possible values available\n * **`_self`** - This will include the resources uri\n * **`_default`** - This will include all default values (Those given with an empty read_mask)\n * This would typically be used in conjunction with other 'non-default' fields\n * Ex:\n * `_default,family,category,_self`\n\n * **dynamic_mask** - A list of dynamically generated values to return about the resource or each resource within the list\n * Comma separated string of variables\n * Operates the same as read_mask, but each variable will incur a much greater time cost.\n * *May* cause timeouts\n * Leaving this field blank or empty will return no dynamic variables.\n\n * **expand_mask** - A list of relational variables to *expand* upon and return more than just the ids\n * Comma separated string of variables\n * Leaving this field blank will cause all relational data to be returned as a list of ids\n * Ex:\n * The `children` field for a file may return a list of ids normally, but with `children` set in the\n `expand_mask`, it can return a list of child File objects with greater details.\n\n---\n\n## POST Conventions\n\nThis will create a new resource.\n\nThe resource data shall be provided in the request body.\n\nThe response will be either a 200 or 201, along with a uri to the newly created resource in the `Location` header.\n\nIn 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\n\n---\n\n## PATCH Conventions\n\n * The update data shall be provided in the request body.\n\n### Possible query parameters:\n **(Check each endpoint description, or use *explain*, for a list of available values for each parameter)**\n\n * **update_mask** - A list of values to update with this request.\n * Comma separated string of variables\n * This is required to be set for any and all **PATCH** requests to be processed.\n * ONLY the specified variables in the update_mask will be updated regardless of the data in the request body.\n * An empty or missing *update_mask* **WILL** result in a 400 Bad Request response\n\n---\n\n## DELETE Conventions\n\nA successful response will return 204 No Content\n\n### Possible query parameters:\n * **force** - Forces the deletion to go through\n * This is required to be set as a truthy value for any and all **DELETE** requests to be processed.\n * Not specifying this on a DELETE request (without *explain* set) **WILL** return a 400 Bad Request response\n\n---\n\n## *bulk* endpoints\n\n**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.\n\nThey **MUST** be a **POST** request along with the accompanying request body parameter to work:\n\n * **ids** - A list of ids to operate on (For **GET**, **PATCH**, and **DELETE** bulk requests)\n * **resources** - A list of resources to operate on (For **POST** bulk requests)\n\n### Possible query parameters:\n **(Check each endpoint description, or use *explain*, for a list of available actions)**\n\n * **action** - This is a string and can only be one of four values:\n\n * **GET** - Returns a list of the resources, in the same order as provided in the request body.\n\n * **POST** - Acts the same as a post on the pluralized resource endpoint.\n * Instead of an **ids** request body parameter being provided in the request body, a **resources** list of new resources must be provided.\n\n * **PATCH** - Acts the same as a patch on a single resource.\n * Follows the same **PATCH** conventions from above*\n\n * **DELETE** - Acts the same as a delete on a single resource.\n * Follows the same **DELETE** conventions from above*\n\n * **strict** - Causes the bulk endpoint to fail if a single provided id fails\n * Boolean\n * If set to True, the bulk call will ONLY operate if it is successful on ALL requested resources.\n * If even a single resource is non-existent/forbidden, the call will fail and no side effects will take place.\n\n---\n\n## Pagination:\n\nPagination can be done in combination with sorting and filtering on most endpoints that deal with lists (including **PATCH** and **DELETE** calls)\n\n### Pagination query paramters:\n\n * **page_size** - The number of results to return (default: 50)\n * **page_count** - The page used in pagination (default: 1)\n * **skip_count** - A specified number of values to skip before collecting values (default: 0)\n\n---\n\n## Sorting:\n\nSorting can be done in combination with filtering and pagination on most endpoints that deal with lists (including **PATCH** and **DELETE** calls)\n\n### Sorting query parameter:\n **(Check each endpoint description, or use *explain*, for a list of available sorters)**\n\n * **order_by** - A list of variables to sort the query on\n * Comma separated string of variables\n * Regex Pattern - `^(-?[\\w]+,?)*$`\n * Variables are sorted in ascending order by default\n * Prepend the variable with a `-` to change it to descending order\n * Multiple sorters can be specified, with precedence matching the order of the parameter\n * Ex:\n * `-object_class,create_time`\n\n---\n\n## Filtering:\n\nFiltering can be done in combination with pagination and sorting on most endpoints that deal with lists (including **PATCH** and **DELETE** calls)\n\n### Filters query parameter:\n **(Check each endpoint description, or use *explain*, for a list of available filters)**\n\n * **filters** - A string of filters used to narrow down the query results.\n * Semi-colon separated string of variables\n * Regex patterns:\n * Single filter:\n * `^\\ *(NOT\\ +)?[\\w]+__[a-z]+\\(.+\\)\\ *`\n\n * `NOT variable__comparator(value)`\n\n * Multiple Filters:\n * `^{SINGLE_FILTER_REGEX}(\\ +(AND|OR|;)\\ +{SINGLE_FILTER_REGEX})*$`\n\n * `NOT variable__comparator(value) AND NOT variable__comparator(value); variable__comparator(value)`\n\n * Logical operator order of precedence:\n * **AND**\n * **OR**\n * **;** **(Semi-colon separation denotes conjunction)**\n * Example order of precedence:\n * **exp1;exp2 AND exp3 OR exp4** is equivalent to **(exp1) AND ((exp2 AND exp3) OR (exp4))**\n\n * Available Comparators:\n * **eq** - Equal\n * **ne** - Not Equal\n * **lt** - Less than\n * **lte** - Less than or equal\n * **gt** - Greater than\n * **gte** - Greater than or equal\n * **in** - In (for list values)\n * **nin** - Not In (for list values)\n * **regex** - Regular Expression Match\n * **iregex** - Case Insensitive Regular Expression Match\n\n * The format for **in** and **nin** which operate on arrays is:\n * **[]** - The list of values must be enclosed within brackets.\n * **,** - The value separtion token is a comma.\n * **<variable\\>__<comp\\>([<value1\\>,<value2\\>])**\n\n * Examples:\n * `create_time__gte(2022-01-01T13:11:02);object_class__regex(binary.*)`\n\n * `create_time__gte(2022-01-01) AND create_time__lt(2022-02-01) AND NOT match_count__gt(10)`\n\n * `create_time__gte(2022-01-01) AND create_time__lt(2022-02-01)`\n\n---\n\n## Responses\n\nAll responses **WILL** be of type `APIResponse` and contain the following fields:\n\n* `success` | Boolean value indicating if the operation succeeded.\n\n* `status` | Status code. Corresponds to the HTTP status code.\n\n* `message` | A human readable message providing more details about the operation.\n\n* `links` | A dictionary of `name`: `uri` links providing navigation and state-based actions on resources\n\n* `errors` | Array of error objects. An error object contains the following properties:\n\n * `reason` | Unique identifier for this error. Ex: \"FileNotFoundError\".\n\n * `message`| Human readable error message.\n\n * `parameter`| The parameter (if any) that caused the issue.\n\nSuccessful operations **MUST** return a `SuccessResponse`, which extends `APIResponse` by adding:\n\n* `success` | **MUST** equal True\n\n* `resource` | Properties containing the response object.\n\n * (In the case of a single entity being returned)\n\n**OR**\n\n* `resources` | A list of response objects.\n\n * (In the case of a list of entities being returned)\n\nFailed Operations **MUST** return an `ErrorResponse`, which extends `APIResponse` by adding:\n\n* `success` | **MUST** equal False.\n\nCommon Failed Operations that you may hit on any of the endpoint operations:\n\n* 400 - Bad Request - The request is malformed\n\n* 401 - Unauthorized - All endpoints require authorization\n\n* 403 - Forbidden - The endpoint (with the given parameters) is not available to you\n\n* 404 - Not Found - The endpoint doesn't exist, or the resource being searched for doesn't exist\n\n---\n\n## Example Inputs\n\nHere are some example inputs that can be used for testing the service:\n\n* `binary_id`: **ff9790d7902fea4c910b182f6e0b00221a40d616**\n\n* `proc_rva`: **0x1000**\n\n* `search_query`: **ransomware**\n\n---\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 2.0.0 (v2)\n- Package version: 2.0.5\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\nFor more information, please visit [https://unknowncyber.com](https://unknowncyber.com)\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install 'git+https://bitbucket.org/unknowncyber/magic-clients.git@v1#egg=cythereal_magic&subdirectory=clients/python'\n```\n(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'`)\n\nThen import the package:\n```python\nimport cythereal_magic \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport cythereal_magic\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport cythereal_magic\nfrom cythereal_magic.rest import ApiException\nfrom pprint import pprint\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\n\ntry:\n # Adds a publicly accessible file to your account\n api_response = api_instance.add_file(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->add_file: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \ntag_id = 'tag_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Associate an existing tag with a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->add_file_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \npayload_id = 'payload_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | Forces a payload to be added, even if one already exists (optional)\n\ntry:\n # Manually add a payload connection to a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->add_payload: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nids = ['ids_example'] # list[str] | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nfilters = '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)\norder_by = 'order_by_example' # str | Comma separated string containing a list of keys to sort on. Prepend with a `-` for descending. REGEX: `^(-?[\\\\w]+,?)*$` (optional)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nexpand_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)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\ndynamic_mask = 'dynamic_mask_example' # str | Comma separated string containing a list of dynamically created fields to return. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\naction = 'action_example' # str | Used in bulk queries. Bulk queries are always POST, so 'action' allows the user to set the desired method (optional)\n\ntry:\n # Allows for actions to be carried out on bulk sets of files\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->bulk_file_operation: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nlabel = 'label_example' # str | \nsource = 'source_example' # str | \nscore = 56 # int | \nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Creates a new custom category label for a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_file_category: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nlabel = 'label_example' # str | \nsource = 'source_example' # str | \nscore = 56 # int | \nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Creates a new custom family label for a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_file_family: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \njob = 'job_example' # str | The job to reprocess for this file\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | Forces a job to be run, even if previously successful (optional)\n\ntry:\n # Send a file for reprocessing\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_file_job: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nnote = 'note_example' # str | \npublic = true # bool | \nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\n\ntry:\n # Attaches a note to a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_file_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nname = 'name_example' # str | (optional)\ncolor = 'color_example' # str | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\n\ntry:\n # Create tag and bind to a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_file_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nfiles = ['files_example'] # list[str] | \nname = 'name_example' # str | \nunpacked = true # bool | \nconfig = NULL # object | \ninclude_all = true # bool | \nmax_signatures = 56 # int | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\nstrict = true # bool | Used for bulk sets of resources. If true, every resource must pass validation in order for any to be operated on (optional)\n\ntry:\n # Create Yara Rule based on multiple file hashes\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_files_yara: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nnote = 'note_example' # str | \npublic = true # bool | \nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Attaches a note to a procedure's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_procedure_genomics_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nname = 'name_example' # str | \nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\n\ntry:\n # Attaches a tag to a procedure's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->create_procedure_genomics_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nnote_id = 'note_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Deletes a specified user note attached to a file\n 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)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->delete_file_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Manually remove a payload connection from a file\n api_instance.delete_payload_relationship(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->delete_payload_relationship: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nnote_id = 'note_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Removes a note from a procedure's genomics\n 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)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->delete_procedure_genomics_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Removes a tag from a procedure's genomics\n 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)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->delete_procedure_genomics_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \ntag_id = 'tag_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Removes a tag from a procedure's genomics\n 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)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->delete_procedure_genomics_tag_by_id: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'format_example' # str | (optional)\nzipped = true # bool | If true, the returned download will be in an encrypted zip file (password=infected) (optional)\n\ntry:\n # Download file\n api_instance.download_file(binary_id, format=format, zipped=zipped)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->download_file: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nexpand_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)\ndynamic_mask = 'dynamic_mask_example' # str | Comma separated string containing a list of dynamically created fields to return. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\n\ntry:\n # Retrieves information for a single file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->get_file: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a file's campaign information\n api_instance.get_file_campaign(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->get_file_campaign: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nnote_id = 'note_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a single note attached to a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->get_file_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nverbose = true # bool | Whether to include all files that infer reputation (optional)\n\ntry:\n # Retrieves the reputation status of the file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->get_file_reputation: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nconfig = 'relaxed' # str | The config of parameters to use when generating a yara rule (optional) (default to relaxed)\ninclude_all = true # bool | Whether to include all procedures (optional)\nunpacked = true # bool | Whether to use unpacked or original binaries (optional)\nname = 'name_example' # str | The name of the yara rule (optional)\n\ntry:\n # Returns a yara rule for the given file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->get_file_yara: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nnote_id = 'note_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a note on a procedure\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->get_procedure_genomics_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a file's category labels\n api_response = api_instance.list_file_categories(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_categories: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Lists all files that were extracted as children\n api_response = api_instance.list_file_children(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_children: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a file's family labels\n api_response = api_instance.list_file_families(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_families: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nno_libs = true # bool | Whether to include library procedures (optional)\norder_by = 'order_by_example' # str | Comma separated string containing a list of keys to sort on. Prepend with a `-` for descending. REGEX: `^(-?[\\\\w]+,?)*$` (optional)\n\ntry:\n # Retrieves a file's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_genomics: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nmalicious = true # bool | Whether to only show malicious indicators (optional) (default to true)\n\ntry:\n # Lists the Indicators of Compromise associated with a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_indicators: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Gets labels for a file\n api_response = api_instance.list_file_labels(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_labels: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nexpand_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)\nmax_threshold = 3.4 # float | Only similarity matches at value equal or below max_threshold will be considered (optional)\nmin_threshold = 3.4 # float | Only similarity matches at value equal or above min_threshold will be considered (optional)\n\ntry:\n # Gets matches for a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_matches: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves all user generated notes for file\n api_response = api_instance.list_file_notes(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_notes: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a file's parent files\n api_response = api_instance.list_file_parents(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_parents: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a procedure's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_procedure_genomics: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nunpacked = true # bool | Whether to use unpacked or original binaries (optional)\n\ntry:\n # Lists all procedures and their information for the given file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_procedures: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nmax_threshold = 3.4 # float | Only similarity matches at value equal or below max_threshold will be considered (optional)\nmethod = 'semantic_similarity' # str | Method to use to find similarities (optional) (default to semantic_similarity)\nmin_threshold = 3.4 # float | Only similarity matches at value equal or above min_threshold will be considered (optional)\n\ntry:\n # Retrieves similar file matches for the specified file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_similarities: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Gets strings for a file\n api_response = api_instance.list_file_strings(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_strings: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nexpand_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)\n\ntry:\n # List all user tags associated with a file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_tags: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nexpand_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)\n\ntry:\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_file_yara_matches: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nfilters = '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)\norder_by = 'order_by_example' # str | Comma separated string containing a list of keys to sort on. Prepend with a `-` for descending. REGEX: `^(-?[\\\\w]+,?)*$` (optional)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nexpand_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)\ndynamic_mask = 'dynamic_mask_example' # str | Comma separated string containing a list of dynamically created fields to return. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\n\ntry:\n # List user files based on the parameters specified\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_files: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a procedure genomics' notes\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_procedure_genomics_notes: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\n\ntry:\n # Retrieves a procedure's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_procedure_genomics_tags: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\nread_mask = 'read_mask_example' # str | Comma separated string containing a list of keys to include in the response. `*` returns all keys. REGEX: `^(([\\\\w]+,?)*|\\\\*)$` (optional)\nmax_threshold = 3.4 # float | Only similarity matches at value equal or below max_threshold will be considered (optional)\nmethod = 'semantic_similarity' # str | Method to use to find similarities (optional) (default to semantic_similarity)\nmin_threshold = 3.4 # float | Only similarity matches at value equal or above min_threshold will be considered (optional)\n\ntry:\n # Retrieves similar procedures to the specified procedure\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->list_procedure_similarities: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Removes a user's ownership from a single file\n api_instance.remove_file(binary_id, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, force=force)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->remove_file: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \ntag_id = 'tag_id_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nforce = true # bool | MUST be true for any `DELETE` method to take place (optional)\n\ntry:\n # Remove an existing tag from a file\n 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)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->remove_file_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nquery = 'query_example' # str | Search query to look for\ntype = 'type_example' # str | Value type with which to search\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\npage_count = 1 # int | (optional) (default to 1)\npage_size = 50 # int | (optional) (default to 50)\nskip_count = 0 # int | (optional) (default to 0)\n\ntry:\n # Search for files based on given parameters\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->search_for_file: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \npublic = true # bool | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nupdate_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)\n\ntry:\n # Updates a single file\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->update_file: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nnote_id = 'note_id_example' # str | \nnote = 'note_example' # str | (optional)\npublic = true # bool | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nupdate_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)\n\ntry:\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->update_file_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nprocedure_name = 'procedure_name_example' # str | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nupdate_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)\n\ntry:\n # Edits a procedure's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->update_file_procedure_genomics: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \ntag_id = 'tag_id_example' # str | \npublic = true # bool | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nupdate_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)\n\ntry:\n # Update a pre-existing file tag\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->update_file_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \nnote_id = 'note_id_example' # str | \nnote = 'note_example' # str | (optional)\npublic = true # bool | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nupdate_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)\n\ntry:\n # Edits a note on a procedure\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->update_procedure_genomics_note: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nbinary_id = 'binary_id_example' # str | \nrva = 'rva_example' # str | \ntag_id = 'tag_id_example' # str | \npublic = true # bool | (optional)\nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\nupdate_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)\n\ntry:\n # Updates a tag from a procedure's genomics\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->update_procedure_genomics_tag: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nfiledata = 'filedata_example' # str | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\n\ntry:\n # Upload an archive containing extracted data to be juiced\n api_response = api_instance.upload_disassembly(filedata, format=format, explain=explain, download=download, filename=filename, no_links=no_links, uri=uri, dryrun=dryrun)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->upload_disassembly: %s\\n\" % e)\n\n# Configure API key authorization: Api Key Header Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\n# Configure API key authorization: Api Key Query Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.api_key['key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['key'] = 'Bearer'# Configure HTTP basic authorization: Basic Authentication\nconfiguration = cythereal_magic.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = cythereal_magic.FilesApi(cythereal_magic.ApiClient(configuration))\nfiledata = ['filedata_example'] # list[str] | \npassword = 'password_example' # str | \ntags = ['tags_example'] # list[str] | \nnotes = ['notes_example'] # list[str] | \nformat = 'json' # str | Format of the response from this endpoint (optional) (default to json)\nexplain = true # bool | Shows the explain for this endpoint (optional)\ndownload = true # bool | Determines whether to download the response.(Content-Disposition:\\\"attachment\\\" vs \\\"inline\\\") (optional)\nfilename = 'filename_example' # str | If download is True, this sets the name of the file. (Content-Disposition:\\\"attachment; filename=`filename`\\\") (optional)\nno_links = true # bool | Removes the 'links' key (optional)\nuri = true # bool | Use resource uri's in place of string ids (optional)\ndryrun = true # bool | If True, don't cause any side effects.(Useful to check that an endpoint will work as constructed) (optional)\nextract = true # bool | If true, all extracted files from an archive will be top level and the archive thrown away (optional)\nrecursive = true # bool | If true, all archives found in the upload will be stripped and thrown (optional)\nretain_wrapper = true # bool | If true with extract, then the archive will not be thrown away (optional) (default to true)\nskip_unpack = true # bool | If true, Unknown Cyber's default unpacker stage will be skipped (optional)\nb64 = true # bool | If true, treat the incoming filedata as a base64 encoded string (optional)\nuse_32 = false # bool | Whether to use 32 bit disassembly (optional) (default to false)\nuse_64 = false # bool | Whether to use 64 bit disassembly (optional) (default to false)\n\ntry:\n # Upload new files for processing\n 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)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FilesApi->upload_file: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api:80/v2/*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FilesApi* | [**add_file**](docs/FilesApi.md#add_file) | **POST** /files/{binary_id}/ | Adds a publicly accessible file to your account\n*FilesApi* | [**add_file_tag**](docs/FilesApi.md#add_file_tag) | **POST** /files/{binary_id}/tags/{tag_id}/ | Associate an existing tag with a file\n*FilesApi* | [**add_payload**](docs/FilesApi.md#add_payload) | **POST** /files/{binary_id}/payload/{payload_id}/ | Manually add a payload connection to a file\n*FilesApi* | [**bulk_file_operation**](docs/FilesApi.md#bulk_file_operation) | **POST** /files/bulk/ | Allows for actions to be carried out on bulk sets of files\n*FilesApi* | [**create_file_category**](docs/FilesApi.md#create_file_category) | **POST** /files/{binary_id}/categories/ | Creates a new custom category label for a file\n*FilesApi* | [**create_file_family**](docs/FilesApi.md#create_file_family) | **POST** /files/{binary_id}/families/ | Creates a new custom family label for a file\n*FilesApi* | [**create_file_job**](docs/FilesApi.md#create_file_job) | **POST** /files/{binary_id}/jobs/ | Send a file for reprocessing\n*FilesApi* | [**create_file_note**](docs/FilesApi.md#create_file_note) | **POST** /files/{binary_id}/notes/ | Attaches a note to a file\n*FilesApi* | [**create_file_tag**](docs/FilesApi.md#create_file_tag) | **POST** /files/{binary_id}/tags/ | Create tag and bind to a file\n*FilesApi* | [**create_files_yara**](docs/FilesApi.md#create_files_yara) | **POST** /files/yara/ | Create Yara Rule based on multiple file hashes\n*FilesApi* | [**create_procedure_genomics_note**](docs/FilesApi.md#create_procedure_genomics_note) | **POST** /files/{binary_id}/genomics/{rva}/notes/ | Attaches a note to a procedure's genomics\n*FilesApi* | [**create_procedure_genomics_tag**](docs/FilesApi.md#create_procedure_genomics_tag) | **POST** /files/{binary_id}/genomics/{rva}/tags/ | Attaches a tag to a procedure's genomics\n*FilesApi* | [**delete_file_note**](docs/FilesApi.md#delete_file_note) | **DELETE** /files/{binary_id}/notes/{note_id}/ | Deletes a specified user note attached to a file\n*FilesApi* | [**delete_payload_relationship**](docs/FilesApi.md#delete_payload_relationship) | **DELETE** /files/{binary_id}/payload/ | Manually remove a payload connection from a file\n*FilesApi* | [**delete_procedure_genomics_note**](docs/FilesApi.md#delete_procedure_genomics_note) | **DELETE** /files/{binary_id}/genomics/{rva}/notes/{note_id}/ | Removes a note from a procedure's genomics\n*FilesApi* | [**delete_procedure_genomics_tag**](docs/FilesApi.md#delete_procedure_genomics_tag) | **DELETE** /files/{binary_id}/genomics/{rva}/tags/ | Removes a tag from a procedure's genomics\n*FilesApi* | [**delete_procedure_genomics_tag_by_id**](docs/FilesApi.md#delete_procedure_genomics_tag_by_id) | **DELETE** /files/{binary_id}/genomics/{rva}/tags/{tag_id}/ | Removes a tag from a procedure's genomics\n*FilesApi* | [**download_file**](docs/FilesApi.md#download_file) | **GET** /files/{binary_id}/download/ | Download file\n*FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /files/{binary_id}/ | Retrieves information for a single file\n*FilesApi* | [**get_file_campaign**](docs/FilesApi.md#get_file_campaign) | **GET** /files/{binary_id}/campaign/ | Retrieves a file's campaign information\n*FilesApi* | [**get_file_note**](docs/FilesApi.md#get_file_note) | **GET** /files/{binary_id}/notes/{note_id}/ | Retrieves a single note attached to a file\n*FilesApi* | [**get_file_reputation**](docs/FilesApi.md#get_file_reputation) | **GET** /files/{binary_id}/reputation/ | Retrieves the reputation status of the file\n*FilesApi* | [**get_file_yara**](docs/FilesApi.md#get_file_yara) | **GET** /files/{binary_id}/yara/ | Returns a yara rule for the given file\n*FilesApi* | [**get_procedure_genomics_note**](docs/FilesApi.md#get_procedure_genomics_note) | **GET** /files/{binary_id}/genomics/{rva}/notes/{note_id}/ | Retrieves a note on a procedure\n*FilesApi* | [**list_file_categories**](docs/FilesApi.md#list_file_categories) | **GET** /files/{binary_id}/categories/ | Retrieves a file's category labels\n*FilesApi* | [**list_file_children**](docs/FilesApi.md#list_file_children) | **GET** /files/{binary_id}/children/ | Lists all files that were extracted as children\n*FilesApi* | [**list_file_families**](docs/FilesApi.md#list_file_families) | **GET** /files/{binary_id}/families/ | Retrieves a file's family labels\n*FilesApi* | [**list_file_genomics**](docs/FilesApi.md#list_file_genomics) | **GET** /files/{binary_id}/genomics/ | Retrieves a file's genomics\n*FilesApi* | [**list_file_indicators**](docs/FilesApi.md#list_file_indicators) | **GET** /files/{binary_id}/indicators/ | Lists the Indicators of Compromise associated with a file\n*FilesApi* | [**list_file_labels**](docs/FilesApi.md#list_file_labels) | **GET** /files/{binary_id}/labels/ | Gets labels for a file\n*FilesApi* | [**list_file_matches**](docs/FilesApi.md#list_file_matches) | **GET** /files/{binary_id}/matches/ | Gets matches for a file\n*FilesApi* | [**list_file_notes**](docs/FilesApi.md#list_file_notes) | **GET** /files/{binary_id}/notes/ | Retrieves all user generated notes for file\n*FilesApi* | [**list_file_parents**](docs/FilesApi.md#list_file_parents) | **GET** /files/{binary_id}/parents/ | Retrieves a file's parent files\n*FilesApi* | [**list_file_procedure_genomics**](docs/FilesApi.md#list_file_procedure_genomics) | **GET** /files/{binary_id}/genomics/{rva}/ | Retrieves a procedure's genomics\n*FilesApi* | [**list_file_procedures**](docs/FilesApi.md#list_file_procedures) | **GET** /files/{binary_id}/procedures/ | Lists all procedures and their information for the given file\n*FilesApi* | [**list_file_similarities**](docs/FilesApi.md#list_file_similarities) | **GET** /files/{binary_id}/similarities/ | Retrieves similar file matches for the specified file\n*FilesApi* | [**list_file_strings**](docs/FilesApi.md#list_file_strings) | **GET** /files/{binary_id}/strings/ | Gets strings for a file\n*FilesApi* | [**list_file_tags**](docs/FilesApi.md#list_file_tags) | **GET** /files/{binary_id}/tags/ | List all user tags associated with a file\n*FilesApi* | [**list_file_yara_matches**](docs/FilesApi.md#list_file_yara_matches) | **GET** /files/{binary_id}/yara/matches/ | \n*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /files/ | List user files based on the parameters specified\n*FilesApi* | [**list_procedure_genomics_notes**](docs/FilesApi.md#list_procedure_genomics_notes) | **GET** /files/{binary_id}/genomics/{rva}/notes/ | Retrieves a procedure genomics' notes\n*FilesApi* | [**list_procedure_genomics_tags**](docs/FilesApi.md#list_procedure_genomics_tags) | **GET** /files/{binary_id}/genomics/{rva}/tags/ | Retrieves a procedure's genomics\n*FilesApi* | [**list_procedure_similarities**](docs/FilesApi.md#list_procedure_similarities) | **GET** /files/{binary_id}/similarities/{rva}/ | Retrieves similar procedures to the specified procedure\n*FilesApi* | [**remove_file**](docs/FilesApi.md#remove_file) | **DELETE** /files/{binary_id}/ | Removes a user's ownership from a single file\n*FilesApi* | [**remove_file_tag**](docs/FilesApi.md#remove_file_tag) | **DELETE** /files/{binary_id}/tags/{tag_id}/ | Remove an existing tag from a file\n*FilesApi* | [**search_for_file**](docs/FilesApi.md#search_for_file) | **GET** /files/search/ | Search for files based on given parameters\n*FilesApi* | [**update_file**](docs/FilesApi.md#update_file) | **PATCH** /files/{binary_id}/ | Updates a single file\n*FilesApi* | [**update_file_note**](docs/FilesApi.md#update_file_note) | **PATCH** /files/{binary_id}/notes/{note_id}/ | \n*FilesApi* | [**update_file_procedure_genomics**](docs/FilesApi.md#update_file_procedure_genomics) | **PATCH** /files/{binary_id}/genomics/{rva}/ | Edits a procedure's genomics\n*FilesApi* | [**update_file_tag**](docs/FilesApi.md#update_file_tag) | **PATCH** /files/{binary_id}/tags/{tag_id}/ | Update a pre-existing file tag\n*FilesApi* | [**update_procedure_genomics_note**](docs/FilesApi.md#update_procedure_genomics_note) | **PATCH** /files/{binary_id}/genomics/{rva}/notes/{note_id}/ | Edits a note on a procedure\n*FilesApi* | [**update_procedure_genomics_tag**](docs/FilesApi.md#update_procedure_genomics_tag) | **PATCH** /files/{binary_id}/genomics/{rva}/tags/{tag_id}/ | Updates a tag from a procedure's genomics\n*FilesApi* | [**upload_disassembly**](docs/FilesApi.md#upload_disassembly) | **POST** /files/disassembly/ | Upload an archive containing extracted data to be juiced\n*FilesApi* | [**upload_file**](docs/FilesApi.md#upload_file) | **POST** /files/ | Upload new files for processing\n*GenomicsApi* | [**compare_files**](docs/GenomicsApi.md#compare_files) | **GET** /genomics/compare/ | Takes in a list of files and sends back comparison results (slow)\n*GroupsApi* | [**add_member**](docs/GroupsApi.md#add_member) | **POST** /groups/{id}/members/{member_id}/ | Adds the `member_id` user to the `id` group\n*GroupsApi* | [**add_new_member**](docs/GroupsApi.md#add_new_member) | **POST** /groups/{id}/members/ | Adds the given user to this group\n*GroupsApi* | [**bulk_group_operation**](docs/GroupsApi.md#bulk_group_operation) | **POST** /groups/bulk/ | Bulk operations on Group resources\n*GroupsApi* | [**create_group**](docs/GroupsApi.md#create_group) | **POST** /groups/ | Create a new group\n*GroupsApi* | [**delete_group**](docs/GroupsApi.md#delete_group) | **DELETE** /groups/{id}/ | Deletes a group\n*GroupsApi* | [**get_group**](docs/GroupsApi.md#get_group) | **GET** /groups/{id}/ | Retrieves detailed information on a single group\n*GroupsApi* | [**get_member**](docs/GroupsApi.md#get_member) | **GET** /groups/{id}/members/{member_id}/ | Returns the user with `member_id` with their `id` group settings\n*GroupsApi* | [**group_login**](docs/GroupsApi.md#group_login) | **GET** /groups/{id}/login/ | Returns a jwt Token for this group\n*GroupsApi* | [**group_logout**](docs/GroupsApi.md#group_logout) | **GET** /groups/logout/ | Converts the group jwt back into a single user jwt\n*GroupsApi* | [**list_groups**](docs/GroupsApi.md#list_groups) | **GET** /groups/ | List all accessible groups\n*GroupsApi* | [**list_members**](docs/GroupsApi.md#list_members) | **GET** /groups/{id}/members/ | List all members of a group\n*GroupsApi* | [**remove_member**](docs/GroupsApi.md#remove_member) | **DELETE** /groups/{id}/members/{member_id}/ | Removes the `member_id` user from the `id` group\n*GroupsApi* | [**update_group**](docs/GroupsApi.md#update_group) | **PATCH** /groups/{id}/ | Updates a group\n*GroupsApi* | [**update_member**](docs/GroupsApi.md#update_member) | **PATCH** /groups/{id}/members/{member_id}/ | Updates the `member_id` user in the `id` group\n*IndicatorsApi* | [**list_iocs**](docs/IndicatorsApi.md#list_iocs) | **GET** /indicators/ | Lists all indicators associated with a user account\n*IndicatorsApi* | [**upload_ioc_file**](docs/IndicatorsApi.md#upload_ioc_file) | **POST** /indicators/files/ | Upload a text or csv file for IoC Extraction\n*ProceduresApi* | [**add_procedure_tag**](docs/ProceduresApi.md#add_procedure_tag) | **POST** /procedures/{proc_hash}/tags/ | Adds a tag to a procedure\n*ProceduresApi* | [**bulk_procedure_operation**](docs/ProceduresApi.md#bulk_procedure_operation) | **POST** /procedures/bulk/ | Get procedures in bulk\n*ProceduresApi* | [**create_procedure_note**](docs/ProceduresApi.md#create_procedure_note) | **POST** /procedures/{proc_hash}/notes/ | Adds a note to a procedure\n*ProceduresApi* | [**create_procedures_yara**](docs/ProceduresApi.md#create_procedures_yara) | **POST** /procedures/yara/ | Create Yara Rule based on given multiple procedures\n*ProceduresApi* | [**delete_procedure_note**](docs/ProceduresApi.md#delete_procedure_note) | **DELETE** /procedures/{proc_hash}/notes/{note_id}/ | Deletes a procedure's note\n*ProceduresApi* | [**delete_procedure_tag**](docs/ProceduresApi.md#delete_procedure_tag) | **DELETE** /procedures/{proc_hash}/tags/{tag_id}/ | Deletes a procedure's tag\n*ProceduresApi* | [**get_procedure**](docs/ProceduresApi.md#get_procedure) | **GET** /procedures/{proc_hash}/ | Get a single procedure\n*ProceduresApi* | [**list_procedure_files**](docs/ProceduresApi.md#list_procedure_files) | **GET** /procedures/{proc_hash}/files/ | Retrieves a procedure's files\n*ProceduresApi* | [**list_procedure_notes**](docs/ProceduresApi.md#list_procedure_notes) | **GET** /procedures/{proc_hash}/notes/ | Lists a procedure's notes\n*ProceduresApi* | [**list_procedure_similarities2**](docs/ProceduresApi.md#list_procedure_similarities2) | **GET** /procedures/{proc_hash}/similarities/ | Lists a procedure's similarities\n*ProceduresApi* | [**list_procedure_tags**](docs/ProceduresApi.md#list_procedure_tags) | **GET** /procedures/{proc_hash}/tags/ | Lists a procedure's tags\n*ProceduresApi* | [**list_procedures**](docs/ProceduresApi.md#list_procedures) | **GET** /procedures/ | Get all procedures\n*ProceduresApi* | [**update_procedure_note**](docs/ProceduresApi.md#update_procedure_note) | **PATCH** /procedures/{proc_hash}/notes/{note_id}/ | Updates a note from a procedure group\n*ProceduresApi* | [**update_procedure_tag**](docs/ProceduresApi.md#update_procedure_tag) | **PATCH** /procedures/{proc_hash}/tags/{tag_id}/ | Updates a tag from a procedure group\n*ReportsApi* | [**get_archive_report**](docs/ReportsApi.md#get_archive_report) | **GET** /reports/{binary_id}/archive/ | Retrieves the report info of a container like file\n*ReportsApi* | [**get_report_features**](docs/ReportsApi.md#get_report_features) | **GET** /reports/{binary_id}/features/ | Retrieves the genomic features of a file\n*SearchApi* | [**count_search_results**](docs/SearchApi.md#count_search_results) | **GET** /search/count/ | Returns total count of results via search\n*SearchApi* | [**search_files**](docs/SearchApi.md#search_files) | **GET** /search/ | Returns files found via search\n*SupportApi* | [**report_bug**](docs/SupportApi.md#report_bug) | **POST** /support/bug/ | Allows users to report a bug within the system\n*TagsApi* | [**bulk_tag_operation**](docs/TagsApi.md#bulk_tag_operation) | **POST** /tags/bulk/ | Lists information on a bulk selection of tags\n*TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /tags/ | Create a new Project for tagging files\n*TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /tags/{id}/ | Deletes a tag\n*TagsApi* | [**delete_tags**](docs/TagsApi.md#delete_tags) | **DELETE** /tags/ | Delete tags in your collection\n*TagsApi* | [**get_tag**](docs/TagsApi.md#get_tag) | **GET** /tags/{id}/ | Retrieves detailed information on a single tag\n*TagsApi* | [**list_tagged_files**](docs/TagsApi.md#list_tagged_files) | **GET** /tags/{id}/files/ | Lists all files associated with this tag\n*TagsApi* | [**list_tags**](docs/TagsApi.md#list_tags) | **GET** /tags/ | List all tags\n*TagsApi* | [**remove_tags**](docs/TagsApi.md#remove_tags) | **DELETE** /tags/{id}/files/ | Removes a tag from all files\n*TagsApi* | [**update_tag**](docs/TagsApi.md#update_tag) | **PATCH** /tags/{id}/ | Updates a tag\n*TagsApi* | [**update_tags**](docs/TagsApi.md#update_tags) | **PATCH** /tags/ | Updates all tags in your collection\n*UsersApi* | [**deactivate_account**](docs/UsersApi.md#deactivate_account) | **DELETE** /users/me/ | Deactivate your account\n*UsersApi* | [**get_account**](docs/UsersApi.md#get_account) | **GET** /users/me/ | Retrieve your account information\n*UsersApi* | [**get_my_group**](docs/UsersApi.md#get_my_group) | **GET** /users/me/groups/{id}/ | Retrieve info for a group\n*UsersApi* | [**leave_my_group**](docs/UsersApi.md#leave_my_group) | **DELETE** /users/me/groups/{id}/ | Leave group\n*UsersApi* | [**leave_my_groups**](docs/UsersApi.md#leave_my_groups) | **DELETE** /users/me/groups/ | Leave all groups\n*UsersApi* | [**list_my_groups**](docs/UsersApi.md#list_my_groups) | **GET** /users/me/groups/ | Lists your groups\n*UsersApi* | [**update_account**](docs/UsersApi.md#update_account) | **PATCH** /users/me/ | Update your account information\n*YaraApi* | [**create_yara**](docs/YaraApi.md#create_yara) | **POST** /yara/ | Create Yara Rule based on specific file hashes\n*YaraApi* | [**yara_procedure_matches**](docs/YaraApi.md#yara_procedure_matches) | **GET** /yara/{binary_id}/matches/ | \n\n## Documentation For Models\n\n - [AllOfDirectReputationReputation](docs/AllOfDirectReputationReputation.md)\n - [AllOfFileAvscan](docs/AllOfFileAvscan.md)\n - [AllOfFileCampaign](docs/AllOfFileCampaign.md)\n - [AllOfFileCategories](docs/AllOfFileCategories.md)\n - [AllOfFileChildAvscan](docs/AllOfFileChildAvscan.md)\n - [AllOfFileChildCampaign](docs/AllOfFileChildCampaign.md)\n - [AllOfFileChildCategories](docs/AllOfFileChildCategories.md)\n - [AllOfFileChildFamilies](docs/AllOfFileChildFamilies.md)\n - [AllOfFileChildLabels](docs/AllOfFileChildLabels.md)\n - [AllOfFileChildMatches](docs/AllOfFileChildMatches.md)\n - [AllOfFileChildNotes](docs/AllOfFileChildNotes.md)\n - [AllOfFileChildPipeline](docs/AllOfFileChildPipeline.md)\n - [AllOfFileChildReputation](docs/AllOfFileChildReputation.md)\n - [AllOfFileChildUnmapped](docs/AllOfFileChildUnmapped.md)\n - [AllOfFileChildren](docs/AllOfFileChildren.md)\n - [AllOfFileFamilies](docs/AllOfFileFamilies.md)\n - [AllOfFileLabels](docs/AllOfFileLabels.md)\n - [AllOfFileMatchResponseAvscan](docs/AllOfFileMatchResponseAvscan.md)\n - [AllOfFileMatchResponseCampaign](docs/AllOfFileMatchResponseCampaign.md)\n - [AllOfFileMatchResponseCategories](docs/AllOfFileMatchResponseCategories.md)\n - [AllOfFileMatchResponseChildren](docs/AllOfFileMatchResponseChildren.md)\n - [AllOfFileMatchResponseFamilies](docs/AllOfFileMatchResponseFamilies.md)\n - [AllOfFileMatchResponseLabels](docs/AllOfFileMatchResponseLabels.md)\n - [AllOfFileMatchResponseMatchType](docs/AllOfFileMatchResponseMatchType.md)\n - [AllOfFileMatchResponseMatches](docs/AllOfFileMatchResponseMatches.md)\n - [AllOfFileMatchResponseNotes](docs/AllOfFileMatchResponseNotes.md)\n - [AllOfFileMatchResponsePipeline](docs/AllOfFileMatchResponsePipeline.md)\n - [AllOfFileMatchResponseReputation](docs/AllOfFileMatchResponseReputation.md)\n - [AllOfFileMatchResponseUnmapped](docs/AllOfFileMatchResponseUnmapped.md)\n - [AllOfFileMatches](docs/AllOfFileMatches.md)\n - [AllOfFileNotes](docs/AllOfFileNotes.md)\n - [AllOfFilePipeline](docs/AllOfFilePipeline.md)\n - [AllOfFilePipelineAltJuiceHandler](docs/AllOfFilePipelineAltJuiceHandler.md)\n - [AllOfFilePipelineDashboardCampaign](docs/AllOfFilePipelineDashboardCampaign.md)\n - [AllOfFilePipelineDashboardReport](docs/AllOfFilePipelineDashboardReport.md)\n - [AllOfFilePipelineIocHandler](docs/AllOfFilePipelineIocHandler.md)\n - [AllOfFilePipelineProcHashSignatures](docs/AllOfFilePipelineProcHashSignatures.md)\n - [AllOfFilePipelineSimilarityComputation](docs/AllOfFilePipelineSimilarityComputation.md)\n - [AllOfFilePipelineSrlJuice](docs/AllOfFilePipelineSrlJuice.md)\n - [AllOfFilePipelineSrlScanners](docs/AllOfFilePipelineSrlScanners.md)\n - [AllOfFilePipelineSrlUnpacker](docs/AllOfFilePipelineSrlUnpacker.md)\n - [AllOfFilePipelineVariantHashSignatures](docs/AllOfFilePipelineVariantHashSignatures.md)\n - [AllOfFilePipelineWebRequestHandler](docs/AllOfFilePipelineWebRequestHandler.md)\n - [AllOfFileReputation](docs/AllOfFileReputation.md)\n - [AllOfFileReputationInferredReputation](docs/AllOfFileReputationInferredReputation.md)\n - [AllOfFileReputationReputation](docs/AllOfFileReputationReputation.md)\n - [AllOfFileUnmapped](docs/AllOfFileUnmapped.md)\n - [AllOfGroupAdmins](docs/AllOfGroupAdmins.md)\n - [AllOfGroupMembers](docs/AllOfGroupMembers.md)\n - [AllOfGroupReducedResponseAdmins](docs/AllOfGroupReducedResponseAdmins.md)\n - [AllOfGroupReducedResponseMembers](docs/AllOfGroupReducedResponseMembers.md)\n - [AllOfInferredReputationCriteria](docs/AllOfInferredReputationCriteria.md)\n - [AllOfInferredReputationReputation](docs/AllOfInferredReputationReputation.md)\n - [AllOfMatchMatchType](docs/AllOfMatchMatchType.md)\n - [AllOfMatchSubtypeMatchSubtype](docs/AllOfMatchSubtypeMatchSubtype.md)\n - [AllOfYaraProcedureRequestCondition](docs/AllOfYaraProcedureRequestCondition.md)\n - [AllOfYaraRequestConfig](docs/AllOfYaraRequestConfig.md)\n - [AvScanResult](docs/AvScanResult.md)\n - [BadRequestResponse](docs/BadRequestResponse.md)\n - [Block](docs/Block.md)\n - [BlockEA](docs/BlockEA.md)\n - [BlockSchema](docs/BlockSchema.md)\n - [BulkGroupRequest](docs/BulkGroupRequest.md)\n - [BulkProcedureRequest](docs/BulkProcedureRequest.md)\n - [BulkProcedureResponse](docs/BulkProcedureResponse.md)\n - [BulkRequest](docs/BulkRequest.md)\n - [BulkTagRequest](docs/BulkTagRequest.md)\n - [ChildResponse](docs/ChildResponse.md)\n - [ChildResponseIdList](docs/ChildResponseIdList.md)\n - [ConditionEnum](docs/ConditionEnum.md)\n - [ConfigEnum](docs/ConfigEnum.md)\n - [CriteriaEnum](docs/CriteriaEnum.md)\n - [DirectReputation](docs/DirectReputation.md)\n - [EnvelopedBulkProcedureResponseList200](docs/EnvelopedBulkProcedureResponseList200.md)\n - [EnvelopedEmpty201](docs/EnvelopedEmpty201.md)\n - [EnvelopedFile200](docs/EnvelopedFile200.md)\n - [EnvelopedFileChildList200](docs/EnvelopedFileChildList200.md)\n - [EnvelopedFileGenomicsResponse200](docs/EnvelopedFileGenomicsResponse200.md)\n - [EnvelopedFileIndicatorResponseList200](docs/EnvelopedFileIndicatorResponseList200.md)\n - [EnvelopedFileLabelCreateResponse201](docs/EnvelopedFileLabelCreateResponse201.md)\n - [EnvelopedFileLabelsList200](docs/EnvelopedFileLabelsList200.md)\n - [EnvelopedFileList200](docs/EnvelopedFileList200.md)\n - [EnvelopedFileList200EnvelopedFileChildList200](docs/EnvelopedFileList200EnvelopedFileChildList200.md)\n - [EnvelopedFileList200EnvelopedIdList200](docs/EnvelopedFileList200EnvelopedIdList200.md)\n - [EnvelopedFileMatchResponseList200](docs/EnvelopedFileMatchResponseList200.md)\n - [EnvelopedFileMatchResponseList200EnvelopedIdList200](docs/EnvelopedFileMatchResponseList200EnvelopedIdList200.md)\n - [EnvelopedFileProcedureResponseList200](docs/EnvelopedFileProcedureResponseList200.md)\n - [EnvelopedFileReputationResponse200](docs/EnvelopedFileReputationResponse200.md)\n - [EnvelopedFileResponse200](docs/EnvelopedFileResponse200.md)\n - [EnvelopedFileResponse201](docs/EnvelopedFileResponse201.md)\n - [EnvelopedFileResponseList200](docs/EnvelopedFileResponseList200.md)\n - [EnvelopedFileSearchResponseList200](docs/EnvelopedFileSearchResponseList200.md)\n - [EnvelopedFileSimilarityResponseList200](docs/EnvelopedFileSimilarityResponseList200.md)\n - [EnvelopedFileStringsResponseList200](docs/EnvelopedFileStringsResponseList200.md)\n - [EnvelopedFileUpdateResponse206](docs/EnvelopedFileUpdateResponse206.md)\n - [EnvelopedFileUploadResponse200](docs/EnvelopedFileUploadResponse200.md)\n - [EnvelopedFileUploadResponse201](docs/EnvelopedFileUploadResponse201.md)\n - [EnvelopedFileUploadResponseList200](docs/EnvelopedFileUploadResponseList200.md)\n - [EnvelopedFileUploadResponseList201](docs/EnvelopedFileUploadResponseList201.md)\n - [EnvelopedGroup200](docs/EnvelopedGroup200.md)\n - [EnvelopedGroupCreatedResponse201](docs/EnvelopedGroupCreatedResponse201.md)\n - [EnvelopedGroupJwtResponse200](docs/EnvelopedGroupJwtResponse200.md)\n - [EnvelopedGroupList200](docs/EnvelopedGroupList200.md)\n - [EnvelopedGroupReducedResponseList200](docs/EnvelopedGroupReducedResponseList200.md)\n - [EnvelopedIdList200](docs/EnvelopedIdList200.md)\n - [EnvelopedIdList201](docs/EnvelopedIdList201.md)\n - [EnvelopedIndicatorFileUploadResponse200](docs/EnvelopedIndicatorFileUploadResponse200.md)\n - [EnvelopedIndicatorResponseList200](docs/EnvelopedIndicatorResponseList200.md)\n - [EnvelopedJobResponse201](docs/EnvelopedJobResponse201.md)\n - [EnvelopedMapping200](docs/EnvelopedMapping200.md)\n - [EnvelopedNamelessNoteList200](docs/EnvelopedNamelessNoteList200.md)\n - [EnvelopedNamelessNoteList200EnvelopedIdList200](docs/EnvelopedNamelessNoteList200EnvelopedIdList200.md)\n - [EnvelopedNote200](docs/EnvelopedNote200.md)\n - [EnvelopedNote201](docs/EnvelopedNote201.md)\n - [EnvelopedNoteList200](docs/EnvelopedNoteList200.md)\n - [EnvelopedPayloadCreateResponse201](docs/EnvelopedPayloadCreateResponse201.md)\n - [EnvelopedProcedureGroup200](docs/EnvelopedProcedureGroup200.md)\n - [EnvelopedProcedureList200](docs/EnvelopedProcedureList200.md)\n - [EnvelopedProcedureResponse200](docs/EnvelopedProcedureResponse200.md)\n - [EnvelopedProcedureSimilarityResponse200](docs/EnvelopedProcedureSimilarityResponse200.md)\n - [EnvelopedSearchCountResponseList200](docs/EnvelopedSearchCountResponseList200.md)\n - [EnvelopedSearchResponseList200](docs/EnvelopedSearchResponseList200.md)\n - [EnvelopedTag200](docs/EnvelopedTag200.md)\n - [EnvelopedTagCreatedResponse200](docs/EnvelopedTagCreatedResponse200.md)\n - [EnvelopedTagCreatedResponse201](docs/EnvelopedTagCreatedResponse201.md)\n - [EnvelopedTagList200](docs/EnvelopedTagList200.md)\n - [EnvelopedTagList200EnvelopedIdList200](docs/EnvelopedTagList200EnvelopedIdList200.md)\n - [EnvelopedTagResponseList200](docs/EnvelopedTagResponseList200.md)\n - [EnvelopedUser200](docs/EnvelopedUser200.md)\n - [EnvelopedUserId201](docs/EnvelopedUserId201.md)\n - [EnvelopedUserList200](docs/EnvelopedUserList200.md)\n - [EnvelopedYara200](docs/EnvelopedYara200.md)\n - [EnvelopedYaraProcedure200](docs/EnvelopedYaraProcedure200.md)\n - [ErrorObject](docs/ErrorObject.md)\n - [ExtendedProcedureResponse](docs/ExtendedProcedureResponse.md)\n - [File](docs/File.md)\n - [FileAddLabelRequest](docs/FileAddLabelRequest.md)\n - [FileAvscan](docs/FileAvscan.md)\n - [FileCampaign](docs/FileCampaign.md)\n - [FileChild](docs/FileChild.md)\n - [FileGenomicsResponse](docs/FileGenomicsResponse.md)\n - [FileIdalessUploadRequest](docs/FileIdalessUploadRequest.md)\n - [FileIndicator](docs/FileIndicator.md)\n - [FileIndicatorResponse](docs/FileIndicatorResponse.md)\n - [FileLabelCreateResponse](docs/FileLabelCreateResponse.md)\n - [FileLabels](docs/FileLabels.md)\n - [FileMatchResponse](docs/FileMatchResponse.md)\n - [FileMatchesIdList](docs/FileMatchesIdList.md)\n - [FileNote](docs/FileNote.md)\n - [FileNoteIdList](docs/FileNoteIdList.md)\n - [FilePipeline](docs/FilePipeline.md)\n - [FileProcedureResponse](docs/FileProcedureResponse.md)\n - [FileProcedures](docs/FileProcedures.md)\n - [FileReputation](docs/FileReputation.md)\n - [FileReputationResponse](docs/FileReputationResponse.md)\n - [FileResponse](docs/FileResponse.md)\n - [FileSearchResponse](docs/FileSearchResponse.md)\n - [FileSimilarityObject](docs/FileSimilarityObject.md)\n - [FileSimilarityResponse](docs/FileSimilarityResponse.md)\n - [FileStringsResponse](docs/FileStringsResponse.md)\n - [FileUpdateResponse](docs/FileUpdateResponse.md)\n - [FileUploadRequest](docs/FileUploadRequest.md)\n - [FileUploadResponse](docs/FileUploadResponse.md)\n - [ForbiddenResponse](docs/ForbiddenResponse.md)\n - [Group](docs/Group.md)\n - [GroupCreatedResponse](docs/GroupCreatedResponse.md)\n - [GroupJwtResponse](docs/GroupJwtResponse.md)\n - [GroupReducedResponse](docs/GroupReducedResponse.md)\n - [GroupRequest](docs/GroupRequest.md)\n - [HashSchema](docs/HashSchema.md)\n - [IndicatorFileUploadResponse](docs/IndicatorFileUploadResponse.md)\n - [IndicatorResponse](docs/IndicatorResponse.md)\n - [InferredData](docs/InferredData.md)\n - [InferredReputation](docs/InferredReputation.md)\n - [InferredReputationEnum](docs/InferredReputationEnum.md)\n - [JobResponse](docs/JobResponse.md)\n - [LabelSchema](docs/LabelSchema.md)\n - [Mapping](docs/Mapping.md)\n - [Match](docs/Match.md)\n - [MatchSubtype](docs/MatchSubtype.md)\n - [MatchSubtypeEnum](docs/MatchSubtypeEnum.md)\n - [MatchTypeEnum](docs/MatchTypeEnum.md)\n - [MiniUser](docs/MiniUser.md)\n - [MiniUserIdList](docs/MiniUserIdList.md)\n - [NameRequest](docs/NameRequest.md)\n - [NamelessNote](docs/NamelessNote.md)\n - [NotFoundResponse](docs/NotFoundResponse.md)\n - [Note](docs/Note.md)\n - [NoteRequest](docs/NoteRequest.md)\n - [PatchedFileUpdateRequest](docs/PatchedFileUpdateRequest.md)\n - [PatchedGroupUpdateRequest](docs/PatchedGroupUpdateRequest.md)\n - [PatchedMemberUpdateRequest](docs/PatchedMemberUpdateRequest.md)\n - [PatchedNoteRequest](docs/PatchedNoteRequest.md)\n - [PatchedPublicRequest](docs/PatchedPublicRequest.md)\n - [PatchedTagColorRequest](docs/PatchedTagColorRequest.md)\n - [PatchedTagRequest](docs/PatchedTagRequest.md)\n - [PatchedUpdateProcedureGenomicRequest](docs/PatchedUpdateProcedureGenomicRequest.md)\n - [PatchedUserUpdateRequest](docs/PatchedUserUpdateRequest.md)\n - [PayloadCreateResponse](docs/PayloadCreateResponse.md)\n - [PipelineStatusEnum](docs/PipelineStatusEnum.md)\n - [Procedure](docs/Procedure.md)\n - [ProcedureBlock](docs/ProcedureBlock.md)\n - [ProcedureGroup](docs/ProcedureGroup.md)\n - [ProcedureResponse](docs/ProcedureResponse.md)\n - [ProcedureSimilarityItem](docs/ProcedureSimilarityItem.md)\n - [ProcedureSimilarityResponse](docs/ProcedureSimilarityResponse.md)\n - [RepData](docs/RepData.md)\n - [SearchCountResponse](docs/SearchCountResponse.md)\n - [SearchResponse](docs/SearchResponse.md)\n - [Tag](docs/Tag.md)\n - [TagCreatedResponse](docs/TagCreatedResponse.md)\n - [TagRequest](docs/TagRequest.md)\n - [TagResponse](docs/TagResponse.md)\n - [TaggedItem](docs/TaggedItem.md)\n - [UnauthenticatedResponse](docs/UnauthenticatedResponse.md)\n - [UploadIocFileRequest](docs/UploadIocFileRequest.md)\n - [UploadTimesChild](docs/UploadTimesChild.md)\n - [User](docs/User.md)\n - [UserId](docs/UserId.md)\n - [UserIdRequest](docs/UserIdRequest.md)\n - [Yara](docs/Yara.md)\n - [YaraProcedure](docs/YaraProcedure.md)\n - [YaraProcedureRequest](docs/YaraProcedureRequest.md)\n - [YaraRequest](docs/YaraRequest.md)\n\n## Documentation For Authorization\n\n\n## Api Key Header Authentication\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n## Api Key Query Authentication\n\n- **Type**: API key\n- **API key parameter name**: key\n- **Location**: URL query string\n\n## Basic Authentication\n\n- **Type**: HTTP basic authentication\n\n## JWT Access Token Authentication\n\n\n\n## Author\n\nsupport@unknowncyber.com\n",
"bugtrack_url": null,
"license": "",
"summary": "MAGIC\u2122 API",
"version": "2.0.5",
"project_urls": null,
"split_keywords": [
"swagger",
"magic\u2122 api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d9fffc077ffefd0d9aac06ed475591d54da94aa3b970776e9796488917c71c0",
"md5": "a363e0afc189a42114d29673f3a035cc",
"sha256": "aff7523186c1c8238380d405c6328cc637a40b305995b9ed19f0a354eb0d2471"
},
"downloads": -1,
"filename": "cythereal_magic-2.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a363e0afc189a42114d29673f3a035cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1399583,
"upload_time": "2023-12-15T20:55:00",
"upload_time_iso_8601": "2023-12-15T20:55:00.410788Z",
"url": "https://files.pythonhosted.org/packages/9d/9f/ffc077ffefd0d9aac06ed475591d54da94aa3b970776e9796488917c71c0/cythereal_magic-2.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "229c98e0a7887d2eb336f64305342c40c4b1a15e1b5996ef312d6d0bd2445564",
"md5": "e2cb4d0edf1e63484df3d2ddf8500d80",
"sha256": "25dc3ef472b9e52ccd6ba8e511fffdba8f1b5bf52ea302771523e80c646a47cb"
},
"downloads": -1,
"filename": "cythereal-magic-2.0.5.tar.gz",
"has_sig": false,
"md5_digest": "e2cb4d0edf1e63484df3d2ddf8500d80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 256768,
"upload_time": "2023-12-15T20:55:05",
"upload_time_iso_8601": "2023-12-15T20:55:05.094679Z",
"url": "https://files.pythonhosted.org/packages/22/9c/98e0a7887d2eb336f64305342c40c4b1a15e1b5996ef312d6d0bd2445564/cythereal-magic-2.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 20:55:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cythereal-magic"
}
