Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v2.63.0
v2.66.0
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Class | Method | HTTP request | Description
*AnalysesDynamicExecutionApi* | [**get_process_registry**](docs/AnalysesDynamicExecutionApi.md#get_process_registry) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/process-registry | Get the dynamic execution results for process registry
*AnalysesDynamicExecutionApi* | [**get_process_tree**](docs/AnalysesDynamicExecutionApi.md#get_process_tree) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/process-tree | Get the dynamic execution results for process tree
*AnalysesDynamicExecutionApi* | [**get_ttps**](docs/AnalysesDynamicExecutionApi.md#get_ttps) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/ttps | Get the dynamic execution results for ttps
*AnalysesResultsMetadataApi* | [**get_analysis_functions_paginated**](docs/AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
*AnalysesResultsMetadataApi* | [**get_capabilities**](docs/AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
*AnalysesResultsMetadataApi* | [**get_communities**](docs/AnalysesResultsMetadataApi.md#get_communities) | **GET** /v2/analyses/{analysis_id}/communities | Gets the communities found in the analysis
*AnalysesResultsMetadataApi* | [**get_functions_list**](docs/AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
Expand Down Expand Up @@ -93,10 +94,7 @@ Class | Method | HTTP request | Description
*CollectionsApi* | [**update_collection**](docs/CollectionsApi.md#update_collection) | **PATCH** /v2/collections/{collection_id} | Updates a collection
*CollectionsApi* | [**update_collection_binaries**](docs/CollectionsApi.md#update_collection_binaries) | **PATCH** /v2/collections/{collection_id}/binaries | Updates a collection binaries
*CollectionsApi* | [**update_collection_tags**](docs/CollectionsApi.md#update_collection_tags) | **PATCH** /v2/collections/{collection_id}/tags | Updates a collection tags
*ExternalSourcesApi* | [**create_external_task_mb**](docs/ExternalSourcesApi.md#create_external_task_mb) | **POST** /v2/analysis/{analysis_id}/external/mb | Pulls data from VirusTotal
*ExternalSourcesApi* | [**create_external_task_vt**](docs/ExternalSourcesApi.md#create_external_task_vt) | **POST** /v2/analysis/{analysis_id}/external/vt | Pulls data from VirusTotal
*ExternalSourcesApi* | [**get_mb_data**](docs/ExternalSourcesApi.md#get_mb_data) | **GET** /v2/analysis/{analysis_id}/external/mb | Get MalwareBazaar data
*ExternalSourcesApi* | [**get_mb_task_status**](docs/ExternalSourcesApi.md#get_mb_task_status) | **GET** /v2/analysis/{analysis_id}/external/mb/status | Check the status of MalwareBazaar data retrieval
*ExternalSourcesApi* | [**get_vt_data**](docs/ExternalSourcesApi.md#get_vt_data) | **GET** /v2/analysis/{analysis_id}/external/vt | Get VirusTotal data
*ExternalSourcesApi* | [**get_vt_task_status**](docs/ExternalSourcesApi.md#get_vt_task_status) | **GET** /v2/analysis/{analysis_id}/external/vt/status | Check the status of VirusTotal data retrieval
*FirmwareApi* | [**get_binaries_for_firmware_task**](docs/FirmwareApi.md#get_binaries_for_firmware_task) | **GET** /v2/firmware/get-binaries/{task_id} | Upload firmware for unpacking
Expand Down Expand Up @@ -159,6 +157,7 @@ Class | Method | HTTP request | Description
- [AnalysisFunctionMapping](docs/AnalysisFunctionMapping.md)
- [AnalysisFunctionMatchingRequest](docs/AnalysisFunctionMatchingRequest.md)
- [AnalysisFunctions](docs/AnalysisFunctions.md)
- [AnalysisFunctionsList](docs/AnalysisFunctionsList.md)
- [AnalysisRecord](docs/AnalysisRecord.md)
- [AnalysisScope](docs/AnalysisScope.md)
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
Expand All @@ -180,6 +179,7 @@ Class | Method | HTTP request | Description
- [BaseResponseAnalysisDetailResponse](docs/BaseResponseAnalysisDetailResponse.md)
- [BaseResponseAnalysisFunctionMapping](docs/BaseResponseAnalysisFunctionMapping.md)
- [BaseResponseAnalysisFunctions](docs/BaseResponseAnalysisFunctions.md)
- [BaseResponseAnalysisFunctionsList](docs/BaseResponseAnalysisFunctionsList.md)
- [BaseResponseAnalysisStringsResponse](docs/BaseResponseAnalysisStringsResponse.md)
- [BaseResponseAnalysisTags](docs/BaseResponseAnalysisTags.md)
- [BaseResponseAnalysisUpdateTagsResponse](docs/BaseResponseAnalysisUpdateTagsResponse.md)
Expand Down Expand Up @@ -318,6 +318,7 @@ Class | Method | HTTP request | Description
- [FunctionInfoInput](docs/FunctionInfoInput.md)
- [FunctionInfoInputFuncDepsInner](docs/FunctionInfoInputFuncDepsInner.md)
- [FunctionInfoOutput](docs/FunctionInfoOutput.md)
- [FunctionListItem](docs/FunctionListItem.md)
- [FunctionLocalVariableResponse](docs/FunctionLocalVariableResponse.md)
- [FunctionMapping](docs/FunctionMapping.md)
- [FunctionMappingFull](docs/FunctionMappingFull.md)
Expand Down
85 changes: 85 additions & 0 deletions docs/AnalysesResultsMetadataApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ All URIs are relative to *https://api.reveng.ai*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_analysis_functions_paginated**](AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
[**get_capabilities**](AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
[**get_communities**](AnalysesResultsMetadataApi.md#get_communities) | **GET** /v2/analyses/{analysis_id}/communities | Gets the communities found in the analysis
[**get_functions_list**](AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
Expand All @@ -13,6 +14,90 @@ Method | HTTP request | Description
[**get_vulnerabilities**](AnalysesResultsMetadataApi.md#get_vulnerabilities) | **GET** /v2/analyses/{analysis_id}/vulnerabilities | Gets the vulnerabilities found in the analysis


# **get_analysis_functions_paginated**
> BaseResponseAnalysisFunctionsList get_analysis_functions_paginated(analysis_id, page=page, page_size=page_size)

Get functions from analysis

Returns a paginated list of functions identified during analysis

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_analysis_functions_list import BaseResponseAnalysisFunctionsList
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
host = "https://api.reveng.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = revengai.AnalysesResultsMetadataApi(api_client)
analysis_id = 56 # int |
page = 1 # int | The page number to retrieve. (optional) (default to 1)
page_size = 1000 # int | Number of items per page. (optional) (default to 1000)

try:
# Get functions from analysis
api_response = api_instance.get_analysis_functions_paginated(analysis_id, page=page, page_size=page_size)
print("The response of AnalysesResultsMetadataApi->get_analysis_functions_paginated:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesResultsMetadataApi->get_analysis_functions_paginated: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |
**page** | **int**| The page number to retrieve. | [optional] [default to 1]
**page_size** | **int**| Number of items per page. | [optional] [default to 1000]

### Return type

[**BaseResponseAnalysisFunctionsList**](BaseResponseAnalysisFunctionsList.md)

### Authorization

[APIKey](../README.md#APIKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Invalid request parameters | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_capabilities**
> BaseResponseCapabilities get_capabilities(analysis_id)

Expand Down
30 changes: 30 additions & 0 deletions docs/AnalysisFunctionsList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AnalysisFunctionsList

API response schema for paginated functions list

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**functions** | [**List[FunctionListItem]**](FunctionListItem.md) | The functions associated with the analysis |

## Example

```python
from revengai.models.analysis_functions_list import AnalysisFunctionsList

# TODO update the JSON string below
json = "{}"
# create an instance of AnalysisFunctionsList from a JSON string
analysis_functions_list_instance = AnalysisFunctionsList.from_json(json)
# print the JSON string representation of the object
print(AnalysisFunctionsList.to_json())

# convert the object into a dict
analysis_functions_list_dict = analysis_functions_list_instance.to_dict()
# create an instance of AnalysisFunctionsList from a dict
analysis_functions_list_from_dict = AnalysisFunctionsList.from_dict(analysis_functions_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


33 changes: 33 additions & 0 deletions docs/BaseResponseAnalysisFunctionsList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# BaseResponseAnalysisFunctionsList


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **bool** | Response status on whether the request succeeded | [optional] [default to True]
**data** | [**AnalysisFunctionsList**](AnalysisFunctionsList.md) | | [optional]
**message** | **str** | | [optional]
**errors** | [**List[ErrorModel]**](ErrorModel.md) | | [optional]
**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional]

## Example

```python
from revengai.models.base_response_analysis_functions_list import BaseResponseAnalysisFunctionsList

# TODO update the JSON string below
json = "{}"
# create an instance of BaseResponseAnalysisFunctionsList from a JSON string
base_response_analysis_functions_list_instance = BaseResponseAnalysisFunctionsList.from_json(json)
# print the JSON string representation of the object
print(BaseResponseAnalysisFunctionsList.to_json())

# convert the object into a dict
base_response_analysis_functions_list_dict = base_response_analysis_functions_list_instance.to_dict()
# create an instance of BaseResponseAnalysisFunctionsList from a dict
base_response_analysis_functions_list_from_dict = BaseResponseAnalysisFunctionsList.from_dict(base_response_analysis_functions_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading