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 for more details

Available controllers

Telmai provides the following controllers for APIs:

Controller
Controller Endpoint
Purpose

Authentication API {auth_endpoint}

https://{telmai_endpoint}/api/auth

Authenitcation and token creation

Configuration API {config_endpoint}

https://{telmai_endpoint}/api/backend/

Configuring connections and assets

Analytics API {analytics_endpoint}

https://{telmai_endpoint}/api/search

Metrics access

Data API {data_endpoint}

https://{telmai_endpoint}/api/data

Upload management

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*

string

Bearer <access_token>. Access token from Authentication API

Last updated