Awesome

dfirtrack-api-client

OpenAPI 3 - Documentation of DFIRTrack API

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

• API version: v2.4.1
• Package version: 2.4.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

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

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

(you may need to run pip with root permission: sudo pip install git+https://github.com/dfirtrack/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:

import time
import dfirtrackapi_client
from pprint import pprint
from dfirtrackapi_client.api import api_api
from dfirtrackapi_client.model.analysisstatus import Analysisstatus
from dfirtrackapi_client.model.artifact import Artifact
from dfirtrackapi_client.model.artifactpriority import Artifactpriority
from dfirtrackapi_client.model.artifactstatus import Artifactstatus
from dfirtrackapi_client.model.artifacttype import Artifacttype
from dfirtrackapi_client.model.auth_token import AuthToken
from dfirtrackapi_client.model.case import Case
from dfirtrackapi_client.model.casepriority import Casepriority
from dfirtrackapi_client.model.casestatus import Casestatus
from dfirtrackapi_client.model.casetype import Casetype
from dfirtrackapi_client.model.company import Company
from dfirtrackapi_client.model.contact import Contact
from dfirtrackapi_client.model.division import Division
from dfirtrackapi_client.model.dnsname import Dnsname
from dfirtrackapi_client.model.domain import Domain
from dfirtrackapi_client.model.domainuser import Domainuser
from dfirtrackapi_client.model.headline import Headline
from dfirtrackapi_client.model.ip import Ip
from dfirtrackapi_client.model.location import Location
from dfirtrackapi_client.model.note import Note
from dfirtrackapi_client.model.notestatus import Notestatus
from dfirtrackapi_client.model.os import Os
from dfirtrackapi_client.model.osarch import Osarch
from dfirtrackapi_client.model.reason import Reason
from dfirtrackapi_client.model.recommendation import Recommendation
from dfirtrackapi_client.model.reportitem import Reportitem
from dfirtrackapi_client.model.serviceprovider import Serviceprovider
from dfirtrackapi_client.model.system import System
from dfirtrackapi_client.model.systemstatus import Systemstatus
from dfirtrackapi_client.model.systemtype import Systemtype
from dfirtrackapi_client.model.systemuser import Systemuser
from dfirtrackapi_client.model.tag import Tag
from dfirtrackapi_client.model.tagcolor import Tagcolor
from dfirtrackapi_client.model.task import Task
from dfirtrackapi_client.model.taskname import Taskname
from dfirtrackapi_client.model.taskpriority import Taskpriority
from dfirtrackapi_client.model.taskstatus import Taskstatus
# 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"
)

# 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 HTTP basic authorization: basicAuth
configuration = dfirtrackapi_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization: bearerAuth
configuration = dfirtrackapi_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)


# 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 = api_api.ApiApi(api_client)
    artifact = Artifact(
        artifact_name="artifact_name_example",
        artifactpriority=1,
        artifactstatus=1,
        artifacttype=1,
        case=1,
        system=1,
        tag=[
            1,
        ],
        artifact_md5="artifact_md5_example",
        artifact_sha1="artifact_sha1_example",
        artifact_sha256="artifact_sha256_example",
        artifact_source_path="artifact_source_path_example",
        artifact_acquisition_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
        artifact_requested_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
        artifact_created_by_user_id=1,
        artifact_modified_by_user_id=1,
        artifact_assigned_to_user_id=1,
    ) # Artifact |  (optional)

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• Analysisstatus
• Artifact
• Artifactpriority
• Artifactstatus
• Artifacttype
• AuthToken
• Case
• Casepriority
• Casestatus
• Casetype
• Company
• Contact
• Division
• Dnsname
• Domain
• Domainuser
• Headline
• Ip
• Location
• Note
• Notestatus
• Os
• Osarch
• Reason
• Recommendation
• Reportitem
• Serviceprovider
• System
• Systemstatus
• Systemtype
• Systemuser
• Tag
• Tagcolor
• Task
• Taskname
• Taskpriority
• Taskstatus

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

bearerAuth

• Type: Bearer authentication

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in dfirtrackapi_client.apis and dfirtrackapi_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from dfirtrackapi_client.api.default_api import DefaultApi
• from dfirtrackapi_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import dfirtrackapi_client
from dfirtrackapi_client.apis import *
from dfirtrackapi_client.models import *