msticpy.context.http_provider module

HTTP Lookup base class.

Input can be a single item or a pandas DataFrame containing multiple items. Processing may require a an API key and processing performance may be limited to a specific number of requests per minute for the account type that you have.

class msticpy.context.http_provider.APILookupParams(path: str = '', verb: str = 'GET', full_url: bool = False, headers: dict[str, str] = NOTHING, params: dict[str, str | float] = NOTHING, data: dict[str, str] = NOTHING, auth_type: str = '', auth_str: list[str] = NOTHING, sub_type: str = '')

Bases: object

HTTP Lookup Params definition.

Method generated by attrs for class APILookupParams.

auth_str: list[str]

auth_type: str

data: dict[str, str]

full_url: bool

headers: dict[str, str]

params: dict[str, str | float]

path: str

sub_type: str

verb: str

class msticpy.context.http_provider.HttpProvider(*, timeout: int | None = None, ApiID: str | None = None, AuthKey: str | None = None, Instance: str | None = None)

Bases: Provider

HTTP Generic lookup provider base class.

For subclasses:

Define Base URL of the service

_BASE_URL = "https://my.api.org/"

Define query parameters for different item types (keys)

..code:: python

_QUERIES: dict[str, APILookupParams] = {}

For example:

_QUERIES = {
# Community API
"ipv4": APILookupParams(
    path="/v3/community/{observable}",
    headers={"key": "{AuthKey}"},
),
# Enterprise API Quick Lookup
"ipv4-quick": APILookupParams(
    ...

Define list of required __init__ params

_REQUIRED_PARAMS: list[str] = []

For example:

_REQUIRED_PARAMS = ["AuthKey"]

In __init__

Be sure to call

super().__init__(**kwargs)``

Supply any additional checkers/pre-processors with