Skip to content

Latest commit

 

History

History
373 lines (259 loc) · 12.5 KB

AnalysesBulkActionsApi.md

File metadata and controls

373 lines (259 loc) · 12.5 KB

revengai.AnalysesBulkActionsApi

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

Method HTTP request Description
bulk_add_analysis_tags PATCH /v2/analyses/tags/add Bulk Add Analysis Tags
bulk_delete_analyses PATCH /v2/analyses/delete Bulk Delete Analyses
v3_batch_add_analysis_tags POST /v3/analyses:batchAddTags Add tags to multiple analyses.
v3_batch_delete_analyses POST /v3/analyses:batchDelete Delete multiple analyses.

bulk_add_analysis_tags

BaseResponseAnalysisBulkAddTagsResponse bulk_add_analysis_tags(analysis_bulk_add_tags_request)

Bulk Add Analysis Tags

Updates analysis tags for multiple analyses. User must be the owner.

Example

  • Api Key Authentication (APIKey):
  • Bearer Authentication (bearerAuth):
import revengai
from revengai.models.analysis_bulk_add_tags_request import AnalysisBulkAddTagsRequest
from revengai.models.base_response_analysis_bulk_add_tags_response import BaseResponseAnalysisBulkAddTagsResponse
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'

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# 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.AnalysesBulkActionsApi(api_client)
    analysis_bulk_add_tags_request = revengai.AnalysisBulkAddTagsRequest() # AnalysisBulkAddTagsRequest | 

    try:
        # Bulk Add Analysis Tags
        api_response = api_instance.bulk_add_analysis_tags(analysis_bulk_add_tags_request)
        print("The response of AnalysesBulkActionsApi->bulk_add_analysis_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalysesBulkActionsApi->bulk_add_analysis_tags: %s\n" % e)

Parameters

Name Type Description Notes
analysis_bulk_add_tags_request AnalysisBulkAddTagsRequest

Return type

BaseResponseAnalysisBulkAddTagsResponse

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • 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] [Back to Model list] [Back to README]

bulk_delete_analyses

BaseResponseDict bulk_delete_analyses(bulk_delete_analyses_request)

Bulk Delete Analyses

Deletes multiple analyses. User must be the owner of all analyses.

Example

  • Api Key Authentication (APIKey):
  • Bearer Authentication (bearerAuth):
import revengai
from revengai.models.base_response_dict import BaseResponseDict
from revengai.models.bulk_delete_analyses_request import BulkDeleteAnalysesRequest
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'

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# 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.AnalysesBulkActionsApi(api_client)
    bulk_delete_analyses_request = revengai.BulkDeleteAnalysesRequest() # BulkDeleteAnalysesRequest | 

    try:
        # Bulk Delete Analyses
        api_response = api_instance.bulk_delete_analyses(bulk_delete_analyses_request)
        print("The response of AnalysesBulkActionsApi->bulk_delete_analyses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalysesBulkActionsApi->bulk_delete_analyses: %s\n" % e)

Parameters

Name Type Description Notes
bulk_delete_analyses_request BulkDeleteAnalysesRequest

Return type

BaseResponseDict

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -
404 Not Found -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_batch_add_analysis_tags

BulkAddTagsOutputBody v3_batch_add_analysis_tags(bulk_add_tags_input_body)

Add tags to multiple analyses.

Adds tags (origin RevEng) to every given analysis' binary. The caller must own every analysis, or none are changed.

Error codes:

Example

  • Api Key Authentication (APIKey):
  • Bearer Authentication (bearerAuth):
import revengai
from revengai.models.bulk_add_tags_input_body import BulkAddTagsInputBody
from revengai.models.bulk_add_tags_output_body import BulkAddTagsOutputBody
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'

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# 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.AnalysesBulkActionsApi(api_client)
    bulk_add_tags_input_body = revengai.BulkAddTagsInputBody() # BulkAddTagsInputBody | 

    try:
        # Add tags to multiple analyses.
        api_response = api_instance.v3_batch_add_analysis_tags(bulk_add_tags_input_body)
        print("The response of AnalysesBulkActionsApi->v3_batch_add_analysis_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AnalysesBulkActionsApi->v3_batch_add_analysis_tags: %s\n" % e)

Parameters

Name Type Description Notes
bulk_add_tags_input_body BulkAddTagsInputBody

Return type

BulkAddTagsOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -
404 Not Found -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v3_batch_delete_analyses

v3_batch_delete_analyses(bulk_delete_analyses_input_body)

Delete multiple analyses.

Deactivates every given analysis. The caller must own all of them, or none are deleted.

Error codes:

Example

  • Api Key Authentication (APIKey):
  • Bearer Authentication (bearerAuth):
import revengai
from revengai.models.bulk_delete_analyses_input_body import BulkDeleteAnalysesInputBody
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'

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# 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.AnalysesBulkActionsApi(api_client)
    bulk_delete_analyses_input_body = revengai.BulkDeleteAnalysesInputBody() # BulkDeleteAnalysesInputBody | 

    try:
        # Delete multiple analyses.
        api_instance.v3_batch_delete_analyses(bulk_delete_analyses_input_body)
    except Exception as e:
        print("Exception when calling AnalysesBulkActionsApi->v3_batch_delete_analyses: %s\n" % e)

Parameters

Name Type Description Notes
bulk_delete_analyses_input_body BulkDeleteAnalysesInputBody

Return type

void (empty response body)

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 No Content -
403 Forbidden -
404 Not Found -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]