sift_py.rest

CLASS	DESCRIPTION
SiftRestConfig	Config class used to to interact with services that use Sift's REST API.`.

FUNCTION	DESCRIPTION
compute_uri

SiftRestConfig

Bases: TypedDict

Config class used to to interact with services that use Sift's REST API.. -uri: The URI of Sift's REST API. The scheme portion of the URI i.e.https://should be ommitted. -apikey: User-generated API key generated via the Sift application. -retry: Urllib3 Retry configuration. If not provided, a default of 3 retries is used. -use_ssl: INTERNAL USE. Meant to be used for local development. -cert_via_openssl: Enable this if you want to use OpenSSL to load the certificates. Runpip install sift-stack-py[openssl]` to install the dependencies required to use this option. Default is False.

ATTRIBUTE	DESCRIPTION
apikey	TYPE: str
cert_via_openssl	TYPE: NotRequired[bool]
retry	TYPE: NotRequired[Retry]
uri	TYPE: str
use_ssl	TYPE: NotRequired[bool]

apikey instance-attribute

apikey: str

cert_via_openssl instance-attribute

cert_via_openssl: NotRequired[bool]

retry instance-attribute

retry: NotRequired[Retry]

uri instance-attribute

uri: str

use_ssl instance-attribute

use_ssl: NotRequired[bool]

compute_uri

compute_uri(restconf: SiftRestConfig) -> str