LogoLogo
HOMEBLOG
  • Getting Started
  • Connect to Data
    • Projects
    • Data Connectors
      • Google BigQuery
      • Google Cloud Storage
      • Iceberg
      • Snowflake
      • AWS S3
      • AWS Athena
      • AWS Redshift
      • Databricks Delta
      • Azure Blob
      • Salesforce
      • SAP Hana
      • File Path Options
      • SQL Server
      • Trino
    • Connection Modes
    • Triggering Scans
    • Configuring a Data Source
  • Profiling Data
    • Data Health Metrics
    • Data Health Overview Page
    • Interactive Profiling Tool: Investigator
    • Data Diff
    • Compound Attributes
      • List of Supported Functions
  • Monitoring Data
    • Data Quality Metrics
    • Alert Policies
    • Data Trends and Alerts
    • Metrics Inspector
  • Data Quality Rules
    • Rules Expression Examples
  • PII Data Detection
  • Remediation
    • Data Binning
    • Circuit Breaker
  • Integrations
    • Jira Integration
    • Slack
    • Jobs Status Notification
  • User Management
    • Okta SSO Setup
    • SSO Configuration
  • API Reference
    • Authentication API
    • API Keys
    • Telmai IP List
    • Get Google Service Account API
  • Source APIs
    • Source APIs
  • Upload Data APIs
    • Upload data from Cloud
      • RedShift Request data
      • GCS Request data
      • Azure Request data
      • GBQ Request data
      • Snowflake Request data
      • Amazon S3 Request data
      • Delta Lake Request
      • Trino Request data
    • Track upload job
    • Check for alerts
  • Admin APIs
    • User Management
  • Telmai Releases
    • Release Notes
      • 25.2.0
      • 25.1.3
      • 25.1.2
      • 25.1.0
Powered by GitBook
On this page
  • Retrieve all API Keys for specific tenant
  • Create an API Key
  • Get details of specific API Key
  • Delete an API Key
  1. API Reference

API Keys

An alternate way to access Telmai APIs using API Key.

PreviousAuthentication APINextTelmai IP List

Last updated 1 month ago

All Telmai APIs can be executed either with OAuth access token or API keys. Use APIs listed below to create a key. Use this key in the header of the Telmai APIs instead of the Authorization bearer token like this:

X-TLM-Key:{API Key}

Execute Authenticate API to retrieve access token for Authorization header used below

Tenant Id can be retrieved from the UI as listed .

Retrieve all API Keys for specific tenant

Retrieves the list of API Keys for the given tenant.

GET /auth/{tenant}/apiKeys

Query Parameters

Name

Type

Description

tenant*

string

Unique Tenant identifier

curl -X 'GET' \ '/auth/<tenant>/apiKeys' -H 'accept: */*'

Responses

{
  "keys": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Unauthorized

Forbidden

Not Found

Create an API Key

Creates a new API key associated with the specified tenant.

POST /auth/{tenant}/apiKeys

Path Parameters

Name
Type
Description

tenant*

string

Unique identifier for the tenant.

Request Body

Name
Type
Description

name*

String

Name of the API Key

curl -X 'POST' \ '/auth/<tenant>/apiKeys' \ -H 'accept: */*' \ -H 'Content-Type: application/json' \ -d '{ "name": "<name>" }'

Responses

{ "id": "string", "name": "string", "key": "string" }

Unauthorized

Forbiddden

Not Found

Get details of specific API Key

Fetches the API key information using a unique key ID for a specific tenant.

GET /auth/{tenant}/apiKeys/{keyId}

Path Parameters

Name
Type
Required
Description

tenant

string

Yes

Tenant identifier

keyId

string

Yes

Unique API Key ID

curl -X 'GET' '/auth/<tenant>/apiKeys/<keyId>' -H 'accept: */*'

Responses

{ "id": "string", "name": "string", }

Unauthorized

Forbiddden

Not Found

Delete an API Key

Removes the API Key with the specified keyId for the given tenant.

Parameters:

Name
Type
Description

tenant*

string

The identifier of the tenant.

keyId*

string

The unique identifier of the API Key to delete.

curl -X 'DELETE' '/auth/<tenant>/apiKeys/<keyId>' -H 'accept: */*'

Responses

{ "message": "string" }

Unauthorized

Forbiddden

Not Found

here