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 @@
v3.46.0
v3.51.0
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ Class | Method | HTTP request | Description
*AnalysesSecurityChecksApi* | [**get_security_checks**](docs/AnalysesSecurityChecksApi.md#get_security_checks) | **GET** /v2/analyses/{analysis_id}/security-checks | Get Security Checks
*AnalysesSecurityChecksApi* | [**get_security_checks_task_status**](docs/AnalysesSecurityChecksApi.md#get_security_checks_task_status) | **GET** /v2/analyses/{analysis_id}/security-checks/status | Check the status of a security check process
*AnalysesXRefsApi* | [**get_xref_by_vaddr**](docs/AnalysesXRefsApi.md#get_xref_by_vaddr) | **GET** /v2/analyses/{analysis_id}/xrefs/{vaddr} | [Beta] Look up xrefs by virtual address
*AnalysisStagesApi* | [**get_analysis_stages**](docs/AnalysisStagesApi.md#get_analysis_stages) | **GET** /v2/analysis-stages/{analysis_id} | Get Analysis Stages
*AnalysisStagesApi* | [**get_pipeline_status**](docs/AnalysisStagesApi.md#get_pipeline_status) | **GET** /v2/analysis-stages/{analysis_id}/pipeline-status | Get Pipeline Status
*AuthenticationUsersApi* | [**get_requester_user_info**](docs/AuthenticationUsersApi.md#get_requester_user_info) | **GET** /v2/users/me | Get the requesters user information
*AuthenticationUsersApi* | [**get_user**](docs/AuthenticationUsersApi.md#get_user) | **GET** /v2/users/{user_id} | Get a user's public information
*AuthenticationUsersApi* | [**get_user_activity**](docs/AuthenticationUsersApi.md#get_user_activity) | **GET** /v2/users/activity | Get auth user activity
Expand Down Expand Up @@ -173,6 +175,9 @@ Class | Method | HTTP request | Description
- [AnalysisFunctionsList](docs/AnalysisFunctionsList.md)
- [AnalysisRecord](docs/AnalysisRecord.md)
- [AnalysisScope](docs/AnalysisScope.md)
- [AnalysisStage](docs/AnalysisStage.md)
- [AnalysisStageStatus](docs/AnalysisStageStatus.md)
- [AnalysisStagesResponse](docs/AnalysisStagesResponse.md)
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
- [AnalysisStringsStatusResponse](docs/AnalysisStringsStatusResponse.md)
- [AnalysisTags](docs/AnalysisTags.md)
Expand All @@ -197,6 +202,7 @@ Class | Method | HTTP request | Description
- [BaseResponseAnalysisFunctionMapping](docs/BaseResponseAnalysisFunctionMapping.md)
- [BaseResponseAnalysisFunctions](docs/BaseResponseAnalysisFunctions.md)
- [BaseResponseAnalysisFunctionsList](docs/BaseResponseAnalysisFunctionsList.md)
- [BaseResponseAnalysisStagesResponse](docs/BaseResponseAnalysisStagesResponse.md)
- [BaseResponseAnalysisStringsResponse](docs/BaseResponseAnalysisStringsResponse.md)
- [BaseResponseAnalysisStringsStatusResponse](docs/BaseResponseAnalysisStringsStatusResponse.md)
- [BaseResponseAnalysisTags](docs/BaseResponseAnalysisTags.md)
Expand Down Expand Up @@ -251,6 +257,7 @@ Class | Method | HTTP request | Description
- [BaseResponseModelsResponse](docs/BaseResponseModelsResponse.md)
- [BaseResponseNetworkOverviewResponse](docs/BaseResponseNetworkOverviewResponse.md)
- [BaseResponseParams](docs/BaseResponseParams.md)
- [BaseResponsePipelineStatusResponse](docs/BaseResponsePipelineStatusResponse.md)
- [BaseResponseProcessDumps](docs/BaseResponseProcessDumps.md)
- [BaseResponseProcessRegistry](docs/BaseResponseProcessRegistry.md)
- [BaseResponseProcessTree](docs/BaseResponseProcessTree.md)
Expand Down Expand Up @@ -400,6 +407,8 @@ Class | Method | HTTP request | Description
- [PEModel](docs/PEModel.md)
- [PaginationModel](docs/PaginationModel.md)
- [Params](docs/Params.md)
- [PipelineStageStatus](docs/PipelineStageStatus.md)
- [PipelineStatusResponse](docs/PipelineStatusResponse.md)
- [Platform](docs/Platform.md)
- [Process](docs/Process.md)
- [ProcessDump](docs/ProcessDump.md)
Expand Down Expand Up @@ -428,6 +437,8 @@ Class | Method | HTTP request | Description
- [SinglePDBEntryModel](docs/SinglePDBEntryModel.md)
- [SingleSectionModel](docs/SingleSectionModel.md)
- [StackVariable](docs/StackVariable.md)
- [StageEvent](docs/StageEvent.md)
- [StageStatus](docs/StageStatus.md)
- [StatusInput](docs/StatusInput.md)
- [StatusOutput](docs/StatusOutput.md)
- [StringFunctions](docs/StringFunctions.md)
Expand Down
14 changes: 14 additions & 0 deletions docs/AnalysisStage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AnalysisStage


## Enum

* `ANALYSIS` (value: `'ANALYSIS'`)

* `POST_PROCESSING` (value: `'POST_PROCESSING'`)

* `INFERENCE` (value: `'INFERENCE'`)

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


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


## Enum

* `QUEUED` (value: `'QUEUED'`)

* `STARTED` (value: `'STARTED'`)

* `FINISHED` (value: `'FINISHED'`)

* `ERROR` (value: `'ERROR'`)

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


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

All URIs are relative to *https://api.reveng.ai*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_analysis_stages**](AnalysisStagesApi.md#get_analysis_stages) | **GET** /v2/analysis-stages/{analysis_id} | Get Analysis Stages
[**get_pipeline_status**](AnalysisStagesApi.md#get_pipeline_status) | **GET** /v2/analysis-stages/{analysis_id}/pipeline-status | Get Pipeline Status


# **get_analysis_stages**
> BaseResponseAnalysisStagesResponse get_analysis_stages(analysis_id)

Get Analysis Stages

Returns all stage events for an analysis ordered by timestamp.

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_analysis_stages_response import BaseResponseAnalysisStagesResponse
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.AnalysisStagesApi(api_client)
analysis_id = 56 # int |

try:
# Get Analysis Stages
api_response = api_instance.get_analysis_stages(analysis_id)
print("The response of AnalysisStagesApi->get_analysis_stages:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysisStagesApi->get_analysis_stages: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |

### Return type

[**BaseResponseAnalysisStagesResponse**](BaseResponseAnalysisStagesResponse.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_pipeline_status**
> BaseResponsePipelineStatusResponse get_pipeline_status(analysis_id)

Get Pipeline Status

Returns the latest status for each core pipeline stage with the number of analyses ahead in the queue.

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_pipeline_status_response import BaseResponsePipelineStatusResponse
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.AnalysisStagesApi(api_client)
analysis_id = 56 # int |

try:
# Get Pipeline Status
api_response = api_instance.get_pipeline_status(analysis_id)
print("The response of AnalysisStagesApi->get_pipeline_status:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysisStagesApi->get_pipeline_status: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |

### Return type

[**BaseResponsePipelineStatusResponse**](BaseResponsePipelineStatusResponse.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)

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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**events** | [**List[StageEvent]**](StageEvent.md) | |

## Example

```python
from revengai.models.analysis_stages_response import AnalysisStagesResponse

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

# convert the object into a dict
analysis_stages_response_dict = analysis_stages_response_instance.to_dict()
# create an instance of AnalysisStagesResponse from a dict
analysis_stages_response_from_dict = AnalysisStagesResponse.from_dict(analysis_stages_response_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/BaseResponseAnalysisStagesResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# BaseResponseAnalysisStagesResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **bool** | Response status on whether the request succeeded | [optional] [default to True]
**data** | [**AnalysisStagesResponse**](AnalysisStagesResponse.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_stages_response import BaseResponseAnalysisStagesResponse

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

# convert the object into a dict
base_response_analysis_stages_response_dict = base_response_analysis_stages_response_instance.to_dict()
# create an instance of BaseResponseAnalysisStagesResponse from a dict
base_response_analysis_stages_response_from_dict = BaseResponseAnalysisStagesResponse.from_dict(base_response_analysis_stages_response_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/BaseResponsePipelineStatusResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# BaseResponsePipelineStatusResponse


## Properties

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

## Example

```python
from revengai.models.base_response_pipeline_status_response import BaseResponsePipelineStatusResponse

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

# convert the object into a dict
base_response_pipeline_status_response_dict = base_response_pipeline_status_response_instance.to_dict()
# create an instance of BaseResponsePipelineStatusResponse from a dict
base_response_pipeline_status_response_from_dict = BaseResponsePipelineStatusResponse.from_dict(base_response_pipeline_status_response_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)


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


## Enum

* `PENDING` (value: `'PENDING'`)

* `QUEUED` (value: `'QUEUED'`)

* `STARTED` (value: `'STARTED'`)

* `FINISHED` (value: `'FINISHED'`)

* `ERROR` (value: `'ERROR'`)

[[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