Introduction

The Incydr SDK is a Python client for interacting with the Code42 Incydr API.

It provides a thin wrapper around the Requests HTTP library with helper clients that model Code42 data and validate requests with the help of Pydantic.

Installation

---

Install using pip:

$ pip install incydr

Import the incydr.Client initialize with your Incydr API Client:

import incydr

client = incydr.Client(
    url="api_domain",
    api_client_id="my_id",
    api_client_secret="my_secret" # (1)
)

You must update the api_domain value for your specific environment. To find the correct value, identify the URL you use to sign in to the Code42 web console, then note the corresponding API Domain value in the table below. Use https for all API requests.

Console Domain	API Domain
console.us.code42.com	api.us.code42.com
console.us2.code42.com	api.us2.code42.com
console.ie.code42.com	api.ie.code42.com
console.gov.code42.com	api.gov.code42.com

Any arguments that are not provided to the incydr.Client will attempt to be loaded from environment variables or .env files. See Settings for more details

The incydr.Client provides helper methods that map to each API action described in the Code42 API Reference. It offers a sub-client for each endpoint namespace and API version. For example, to interact with /v1/cases endpoints:

>>> import incydr
>>> client = incydr.Client()
>>> client.cases.v1.create(name="Test", description="Created with Incydr SDK")
Case(
    number=28,
    name='Test',
    created_at=datetime.datetime(2022, 8, 2, 13, 11, 7, 803762, tzinfo=datetime.timezone.utc),
    updated_at=datetime.datetime(2022, 8, 2, 13, 11, 7, 803762, tzinfo=datetime.timezone.utc),
    description='Created with Incydr SDK',
    findings=None,
    subject=None,
    subject_username=None,
    status='OPEN',
    assignee=None,
    assignee_username=None,
    created_by_user_id=None,
    created_by_username=None,
    last_modified_by_user_id=None,
    last_modified_by_username=None
)

Methods return data wrapped in Pydantic model classes, providing great editor support like autocomplete and type hinting.