Skip to content

API

API

The entry point for interacting with the CRIPT REST API.

Parameters:

Name Type Description Default
host str

The hostname of the relevant CRIPT instance. (e.g., criptapp.org)

None
token str

The API token used for authentication.

None
tls bool

Indicates whether to use TLS encryption for the API connection.

True

APILocal

The entry point for interacting with your local filesystem.

Parameters:

Name Type Description Default
folder Union[str, pathlib.Path]

Path to a folder on your local filesystem.

required