dfirtrack-api-client

OpenAPI 3 - Documentation of DFIRTrack API

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

API version: 0.4.1
Package version: 0.4.1
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

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

pip install git+https://github.com/n3x77/dfirtrack-api-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/n3x77/dfirtrack-api-python-client.git)

Then import the package:

import dfirtrackapi_client

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 dfirtrackapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import dfirtrackapi_client
from dfirtrackapi_client.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 = dfirtrackapi_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with dfirtrackapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dfirtrackapi_client.ApiApi(api_client)
    artifact = dfirtrackapi_client.Artifact() # Artifact |  (optional)

    try:
        api_response = api_instance.create_artifact(artifact=artifact)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiApi->create_artifact: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request
ApiApi	create_artifact	POST /api/artifact/
ApiApi	create_artifacttype	POST /api/artifacttype/
ApiApi	create_case	POST /api/case/
ApiApi	create_company	POST /api/company/
ApiApi	create_contact	POST /api/contact/
ApiApi	create_division	POST /api/division/
ApiApi	create_dnsname	POST /api/dnsname/
ApiApi	create_domain	POST /api/domain/
ApiApi	create_domainuser	POST /api/domainuser/
ApiApi	create_ip	POST /api/ip/
ApiApi	create_location	POST /api/location/
ApiApi	create_os	POST /api/os/
ApiApi	create_osarch	POST /api/osarch/
ApiApi	create_reason	POST /api/reason/
ApiApi	create_recommendation	POST /api/recommendation/
ApiApi	create_serviceprovider	POST /api/serviceprovider/
ApiApi	create_system	POST /api/system/
ApiApi	create_systemtype	POST /api/systemtype/
ApiApi	create_systemuser	POST /api/systemuser/
ApiApi	create_tag	POST /api/tag/
ApiApi	create_task	POST /api/task/
ApiApi	create_taskname	POST /api/taskname/
ApiApi	list_analysisstatus	GET /api/analysisstatus/
ApiApi	list_artifacts	GET /api/artifact/
ApiApi	list_artifactstatus	GET /api/artifactstatus/
ApiApi	list_artifacttypes	GET /api/artifacttype/
ApiApi	list_cases	GET /api/case/
ApiApi	list_companys	GET /api/company/
ApiApi	list_contacts	GET /api/contact/
ApiApi	list_divisions	GET /api/division/
ApiApi	list_dnsnames	GET /api/dnsname/
ApiApi	list_domains	GET /api/domain/
ApiApi	list_domainusers	GET /api/domainuser/
ApiApi	list_ips	GET /api/ip/
ApiApi	list_locations	GET /api/location/
ApiApi	list_os	GET /api/os/
ApiApi	list_osarchs	GET /api/osarch/
ApiApi	list_reasons	GET /api/reason/
ApiApi	list_recommendations	GET /api/recommendation/
ApiApi	list_serviceproviders	GET /api/serviceprovider/
ApiApi	list_systems	GET /api/system/
ApiApi	list_systemstatus	GET /api/systemstatus/
ApiApi	list_systemtypes	GET /api/systemtype/
ApiApi	list_systemusers	GET /api/systemuser/
ApiApi	list_tagcolors	GET /api/tagcolor/
ApiApi	list_tags	GET /api/tag/
ApiApi	list_tasknames	GET /api/taskname/
ApiApi	list_taskprioritys	GET /api/taskpriority/
ApiApi	list_tasks	GET /api/task/
ApiApi	list_taskstatus	GET /api/taskstatus/
ApiApi	partial_update_artifact	PATCH /api/artifact/{artifact_id}/
ApiApi	partial_update_artifacttype	PATCH /api/artifacttype/{artifacttype_id}/
ApiApi	partial_update_case	PATCH /api/case/{case_id}/
ApiApi	partial_update_company	PATCH /api/company/{company_id}/
ApiApi	partial_update_contact	PATCH /api/contact/{contact_id}/
ApiApi	partial_update_division	PATCH /api/division/{division_id}/
ApiApi	partial_update_dnsname	PATCH /api/dnsname/{dnsname_id}/
ApiApi	partial_update_domain	PATCH /api/domain/{domain_id}/
ApiApi	partial_update_domainuser	PATCH /api/domainuser/{domainuser_id}/
ApiApi	partial_update_ip	PATCH /api/ip/{ip_id}/
ApiApi	partial_update_location	PATCH /api/location/{location_id}/
ApiApi	partial_update_os	PATCH /api/os/{os_id}/
ApiApi	partial_update_osarch	PATCH /api/osarch/{osarch_id}/
ApiApi	partial_update_reason	PATCH /api/reason/{reason_id}/
ApiApi	partial_update_recommendation	PATCH /api/recommendation/{recommendation_id}/
ApiApi	partial_update_serviceprovider	PATCH /api/serviceprovider/{serviceprovider_id}/
ApiApi	partial_update_system	PATCH /api/system/{system_id}/
ApiApi	partial_update_systemtype	PATCH /api/systemtype/{systemtype_id}/
ApiApi	partial_update_systemuser	PATCH /api/systemuser/{systemuser_id}/
ApiApi	partial_update_tag	PATCH /api/tag/{tag_id}/
ApiApi	partial_update_task	PATCH /api/task/{task_id}/
ApiApi	partial_update_taskname	PATCH /api/taskname/{taskname_id}/
ApiApi	retrieve_analysisstatus	GET /api/analysisstatus/{analysisstatus_id}/
ApiApi	retrieve_artifact	GET /api/artifact/{artifact_id}/
ApiApi	retrieve_artifactstatus	GET /api/artifactstatus/{artifactstatus_id}/
ApiApi	retrieve_artifacttype	GET /api/artifacttype/{artifacttype_id}/
ApiApi	retrieve_case	GET /api/case/{case_id}/
ApiApi	retrieve_company	GET /api/company/{company_id}/
ApiApi	retrieve_contact	GET /api/contact/{contact_id}/
ApiApi	retrieve_division	GET /api/division/{division_id}/
ApiApi	retrieve_dnsname	GET /api/dnsname/{dnsname_id}/
ApiApi	retrieve_domain	GET /api/domain/{domain_id}/
ApiApi	retrieve_domainuser	GET /api/domainuser/{domainuser_id}/
ApiApi	retrieve_ip	GET /api/ip/{ip_id}/
ApiApi	retrieve_location	GET /api/location/{location_id}/
ApiApi	retrieve_os	GET /api/os/{os_id}/
ApiApi	retrieve_osarch	GET /api/osarch/{osarch_id}/
ApiApi	retrieve_reason	GET /api/reason/{reason_id}/
ApiApi	retrieve_recommendation	GET /api/recommendation/{recommendation_id}/
ApiApi	retrieve_serviceprovider	GET /api/serviceprovider/{serviceprovider_id}/
ApiApi	retrieve_system	GET /api/system/{system_id}/
ApiApi	retrieve_systemstatus	GET /api/systemstatus/{systemstatus_id}/
ApiApi	retrieve_systemtype	GET /api/systemtype/{systemtype_id}/
ApiApi	retrieve_systemuser	GET /api/systemuser/{systemuser_id}/
ApiApi	retrieve_tag	GET /api/tag/{tag_id}/
ApiApi	retrieve_tagcolor	GET /api/tagcolor/{tagcolor_id}/
ApiApi	retrieve_task	GET /api/task/{task_id}/
ApiApi	retrieve_taskname	GET /api/taskname/{taskname_id}/
ApiApi	retrieve_taskpriority	GET /api/taskpriority/{taskpriority_id}/
ApiApi	retrieve_taskstatus	GET /api/taskstatus/{taskstatus_id}/
ApiApi	update_artifact	PUT /api/artifact/{artifact_id}/
ApiApi	update_artifacttype	PUT /api/artifacttype/{artifacttype_id}/
ApiApi	update_case	PUT /api/case/{case_id}/
ApiApi	update_company	PUT /api/company/{company_id}/
ApiApi	update_contact	PUT /api/contact/{contact_id}/
ApiApi	update_division	PUT /api/division/{division_id}/
ApiApi	update_dnsname	PUT /api/dnsname/{dnsname_id}/
ApiApi	update_domain	PUT /api/domain/{domain_id}/
ApiApi	update_domainuser	PUT /api/domainuser/{domainuser_id}/
ApiApi	update_ip	PUT /api/ip/{ip_id}/
ApiApi	update_location	PUT /api/location/{location_id}/
ApiApi	update_os	PUT /api/os/{os_id}/
ApiApi	update_osarch	PUT /api/osarch/{osarch_id}/
ApiApi	update_reason	PUT /api/reason/{reason_id}/
ApiApi	update_recommendation	PUT /api/recommendation/{recommendation_id}/
ApiApi	update_serviceprovider	PUT /api/serviceprovider/{serviceprovider_id}/
ApiApi	update_system	PUT /api/system/{system_id}/
ApiApi	update_systemtype	PUT /api/systemtype/{systemtype_id}/
ApiApi	update_systemuser	PUT /api/systemuser/{systemuser_id}/
ApiApi	update_tag	PUT /api/tag/{tag_id}/
ApiApi	update_task	PUT /api/task/{task_id}/
ApiApi	update_taskname	PUT /api/taskname/{taskname_id}/

Documentation For Models

Documentation For Authorization

BasicAuth

Type: HTTP basic authentication

Author

Sven Pueschel spueschel89@gmail.com

stuhli/dfirtrack-api-python-client