Requirements

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install odin-sdk

You may need to run pip with root permission: sudo pip install odin-sdk

Then import the package:

import odin

Getting Started

from __future__ import print_function
import time
import odin
from odin.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = odin.Configuration()
configuration.api_key['X-API-Key'] = '<API-Key>'

# Search exposed buckets (using pagination)
api_instance = odin.ExposedBucketsApi(odin.ApiClient(configuration))
try:
    results, last = [], None
    for _ in range(3):
        resp = api_instance.v1_exposed_buckets_search_post(
            {
                "query": 'name:"lit-link-prd.appspot.com"',
                "limit": 1,
                "start": last,
            }
        )
        results.extend(resp)

        last = resp.get("pagination", {}).get("last")
except ApiException as e:
    # Handle exception
    pass

# Search files in an exposed bucket
api_instance = odin.ExposedFilesApi(odin.ApiClient(configuration))
try:
    resp = api_instance.v1_exposed_files_search_post(
        {
            "query": 'provider: aws',
            "limit": 1,
            "sortDir": "desc",
            "sortBy": "files"
        }
    )
    resp
except ApiException as e:
    # Handle exception
    pass

API Methods Examples

# Search hosts
api_instance = odin.HostsApi(odin.ApiClient(configuration))
try:
    resp = api_instance.v1_hosts_search_post(
        {
            "query": "(last_updated_at:[\"2024-07-08T02:41:15.528Z\" TO *] AND services.port:80) OR asn.number:AS63949",
            "limit": 1
        }
    )
    resp
except ApiException as e:
    # Handle exception
    pass

Host CVE IP

# Hosts CVE IP
api_instance = odin.HostsApi(odin.ApiClient(configuration))
try:
    resp = api_instance.v1_hosts_cve_ip_get("<ip>")
    resp.to_dict()
except ApiException as e:
    # Handle exception
    pass

Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

Generate your Odin API key from the odin dashboard.

Additional Resources

If you encounter any issues, find a bug, or want to contribute, feel free to open an issue or submit a pull request. Your feedback and contributions are highly appreciated!

For more information about our other projects and services, visit our website at https://odin.io.

SDK Metadata

  • API version: 1.0
  • Package version: 2.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen