turbinia-api-lib 1.0.6

Turbinia API Server

turbinia-api-lib

Turbinia is an open-source framework for deploying, managing, and running distributed forensic workloads

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.7.0
• Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import turbinia_api_lib

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import turbinia_api_lib

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import turbinia_api_lib
from turbinia_api_lib.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = turbinia_api_lib.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with turbinia_api_lib.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = turbinia_api_lib.TurbiniaConfigurationApi(api_client)

    try:
        # Download Configuration
        api_response = api_instance.download_config()
        print("The response of TurbiniaConfigurationApi->download_config:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TurbiniaConfigurationApi->download_config: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
TurbiniaConfigurationApi	download_config	GET /api/config/download	Download Configuration
TurbiniaConfigurationApi	get_request_options	GET /api/config/request_options	Get Request Options
TurbiniaConfigurationApi	get_version	GET /api/config/version	Get Version
TurbiniaConfigurationApi	read_config	GET /api/config/	Read Config
TurbiniaEvidenceApi	download_by_evidence_id	GET /api/evidence/download/{evidence_id}	Download By Evidence Id
TurbiniaEvidenceApi	get_evidence_attributes	GET /api/evidence/types/{evidence_type}	Get Evidence Attributes
TurbiniaEvidenceApi	get_evidence_by_id	GET /api/evidence/{evidence_id}	Get Evidence By Id
TurbiniaEvidenceApi	get_evidence_summary	GET /api/evidence/summary	Get Evidence Summary
TurbiniaEvidenceApi	get_evidence_types	GET /api/evidence/types	Get Evidence Types
TurbiniaEvidenceApi	query_evidence	GET /api/evidence/query	Query Evidence
TurbiniaEvidenceApi	upload_evidence	POST /api/evidence/upload	Upload Evidence
TurbiniaJobsApi	read_jobs	GET /api/jobs/	Read Jobs
TurbiniaLogsApi	get_api_server_logs	GET /api/logs/api_server	Get Api Server Logs
TurbiniaLogsApi	get_server_logs	GET /api/logs/server	Get Server Logs
TurbiniaLogsApi	get_turbinia_logs	GET /api/logs/{hostname}	Get Turbinia Logs
TurbiniaRequestResultsApi	get_plaso_file	GET /api/result/plasofile/{task_id}	Get Plaso File
TurbiniaRequestResultsApi	get_request_output	GET /api/result/request/{request_id}	Get Request Output
TurbiniaRequestResultsApi	get_task_output	GET /api/result/task/{task_id}	Get Task Output
TurbiniaRequestsApi	create_request	POST /api/request/	Create Request
TurbiniaRequestsApi	get_request_report	GET /api/request/report/{request_id}	Get Request Markdown Report
TurbiniaRequestsApi	get_request_status	GET /api/request/{request_id}	Get Request Status
TurbiniaRequestsApi	get_requests_summary	GET /api/request/summary	Get Requests Summary
TurbiniaTasksApi	download_output_path	GET /api/download/output/{file_path}	Get Task Report
TurbiniaTasksApi	get_task_report	GET /api/task/report/{task_id}	Get Task Report
TurbiniaTasksApi	get_task_statistics	GET /api/task/statistics	Get Task Statistics
TurbiniaTasksApi	get_task_status	GET /api/task/{task_id}	Get Task Status
TurbiniaTasksApi	get_workers_status	GET /api/task/workers	Get Workers Status

Documentation For Models

• BaseRequestOptions
• CompleteTurbiniaStats
• HTTPValidationError
• LocationInner
• Request
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

oAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://accounts.google.com/o/oauth2/v2/auth
• Scopes: N/A

Author