# Telmai APIs

Telmai offers APIs that allows users to:

* Configure connections and assets
* Trigger scan
* Manage users
* Retrieve result data

### Authentication

Authentication can be specified through:

* User name & password
* API Key
* API token

Please refer to [Authentication API ](https://docs.telm.ai/telmai/api-reference/authentication-api)for more details

### Available controllers

Telmai provides the following controllers for APIs:

<table><thead><tr><th width="187.6328125">Controller</th><th width="306.6796875">Controller Endpoint</th><th>Purpose</th></tr></thead><tbody><tr><td>Authentication API <code>{auth_endpoint}</code></td><td><code>https://{telmai_endpoint}/api/auth</code></td><td>Authenitcation and token creation</td></tr><tr><td>Configuration API <code>{config_endpoint}</code></td><td><code>https://{telmai_endpoint}/api/backend/</code></td><td>Configuring connections and assets</td></tr><tr><td>Analytics API <code>{analytics_endpoint}</code></td><td><code>https://{telmai_endpoint}/api/search</code></td><td>Metrics access</td></tr><tr><td>Data API <code>{data_endpoint}</code></td><td><code>https://{telmai_endpoint}/api/data</code></td><td>Upload management</td></tr></tbody></table>

These controllers can be used for the corresponding Telmai instance:

`https://{telmai_endpoint}/{controller_endpoint}/{function}`

### Headers

The following headers are always required when calling Telmai APIs

| Name                                             | Type   | Description                                                   |
| ------------------------------------------------ | ------ | ------------------------------------------------------------- |
| Content-type                                     | string | application/json                                              |
| Authentication<mark style="color:red;">\*</mark> | string | Bearer \<access\_token>. Access token from Authentication API |