> For the complete documentation index, see [llms.txt](https://docs.datasentinel.io/manual/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.datasentinel.io/manual/implementation/platform-usage.md).

# Platform Usage

How to operate the Datasentinel platform once it is installed: configure it, drive it through its API, use its command-line tools, and read its log files.

This section covers the daily operation of the platform. It has four parts.

| Part                                                                                                | What it covers                                                 | Used from                                      |
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------- |
| [Configuration](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration.md) | License, users and roles, LDAP, SMTP, audit, backend settings  | The user interface, and one configuration file |
| [API Reference](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference.md) | Connections, roles, users, reports, workload export, alerting  | Scripts and external tools                     |
| [Tooling](https://docs.datasentinel.io/manual/implementation/platform-usage/tooling.md)             | Shell scripts that display or change the state of the platform | A terminal on the platform server              |
| [Log Files](https://docs.datasentinel.io/manual/implementation/platform-usage/log-files.md)         | Where each component writes its logs                           | A terminal on the platform server              |

## Configuration

Most settings are changed in the user interface, in the tools menu.

| Page                                                                                                                              | What you set                                                                                     |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| [License](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/license.md)                             | The license token of the platform and of the agents                                              |
| [Users & Roles](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/users-and-roles.md)               | The users, their privileges, and their access to Live360                                         |
| [Default RBAC Behavior](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/default-rbac-behavior.md) | Whether a user without a role sees all the instances or none                                     |
| [LDAP](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/ldap.md)                                   | Authentication of the users through an LDAP server                                               |
| [SMTP](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/smtp.md)                                   | The mail server used for alert notifications and reports                                         |
| [Audit](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/audit.md)                                 | The record of user actions. Enabled on a new installation, with a 60-day retention.              |
| [Backend](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/backend.md)                             | The backend processes, the purge of inactive instances, and the settings of the agentless agents |

{% hint style="info" %}
Email notifications and emailed reports need the SMTP server to be configured first.
{% endhint %}

## API Reference

The platform API lets you automate what the interface does. Every call needs an access token: start with [Access Token](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/access-token.md).

| API                                                                                                         | What you can do                                                                              |
| ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| [Connection](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/connection.md) | Add, display, update, enable, disable and delete agentless connections. On-premises only.    |
| [Role](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/role.md)             | Create, display and replace roles, and see the users assigned to them                        |
| [User](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/user.md)             | Manage the users                                                                             |
| [Reporting](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/reporting.md)   | Generate each type of PDF report, and send it by email                                       |
| [Workload](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/workload.md)     | Export metrics in JSON or CSV: session history, queries, instances, tables, indexes, servers |
| [Alerting](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/alerting.md)     | Enable or disable alerting for an instance, list its problems, create customized alerts      |

{% hint style="info" %}
The [Datasentinel toolkit](https://github.com/datasentinel/datasentinel_toolkit) provides ready-to-use examples for these APIs. It is pre-installed on the on-premises platform, in **`/datasentinel/soft/datasentinel_toolkit`**.
{% endhint %}

## Tooling

The [tooling](https://docs.datasentinel.io/manual/implementation/platform-usage/tooling.md) scripts are run in a terminal, as the Datasentinel owner.

| You want to                                                            | Script topic                 |
| ---------------------------------------------------------------------- | ---------------------------- |
| See the version and the license status                                 | Informations                 |
| Update the license                                                     | Token Update                 |
| List the agents and the monitored instances                            | Registered Agents, Inventory |
| List or purge the instances that no longer send metrics                | Inactive Instances           |
| Manage the sessions of AI assistants                                   | AI Assistant Sessions        |
| Export the roles, user settings, agentless connections and alert rules | Dump                         |
| Manage the agentless agents and connections                            | Agentless Method             |

For diagnosis scripts, see [Platform Diagnostics Tools](https://docs.datasentinel.io/manual/implementation/troubleshooting/platform-diagnostics-tools.md).

## Log Files

The platform writes its logs in the `/datasentinel/log` directory, except for the NGINX log file. See [Log Files](https://docs.datasentinel.io/manual/implementation/platform-usage/log-files.md) for the file of each component.

## See also

* [Upgrade](https://docs.datasentinel.io/manual/implementation/upgrade.md): update the platform and the agents.
* [Troubleshooting](https://docs.datasentinel.io/manual/implementation/troubleshooting.md): diagnose a problem.
* [Agent Usage](https://docs.datasentinel.io/manual/implementation/agent-usage.md): operate the agents.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.datasentinel.io/manual/implementation/platform-usage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
