Skip to content

Commit

Permalink
[Documentation] timesketch_client.TimesketchApi in api client documen…
Browse files Browse the repository at this point in the history
…tation (#2938)

* mention timesketch_client.TimesketchApi in api client documentation

* adding a warning to be careful using that
  • Loading branch information
jaegeral authored Oct 11, 2023
1 parent 15a7991 commit 789a7dd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/developers/api-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ ts_client = config.get_client(token_password='MY_SUPER_L337_PWD')

If the token file does not exist, it will be generated and encrypted using the supplied password.

### Directly passing username / password

Another option to create a connection to the Timesketch server is by creating an `TimesketchApi` object and passing `

```python
from timesketch_api_client import client as timesketch_client
client = timesketch_client.TimesketchApi(host_uri='https://demo.timesketch.org', username='demo', password='demo')
```

> Careful with storing credentials in code that you intend to publish or make available to others.
## Client Config

In order to make it simpler to connect to the API client a config file
Expand Down

0 comments on commit 789a7dd

Please sign in to comment.