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
    • Microsoft Entra IDP Setup
    • Auth0 Setup
    • 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.1
      • 25.2.0
      • 25.1.3
      • 25.1.2
      • 25.1.0
Powered by GitBook
On this page
  • Create a source
  • List all sources for this tenant
  • Update a source
  • Get details of a specific source
  • Delete Source
  1. Source APIs

Source APIs

APIs to manage a Telmai source

Tenant Id can be retrieved from the UI as listed here.

Create a source

POST https://env1.telm.ai/api/backend/{tenant}/configuration/sources

Create a new source in the tenant

Path Parameters

Name
Type
Description

tenant*

string

Tenant Id

Query Parameters

Name
Type
Description

name*

string

Name of source

description

string

Description of source

Headers

Name
Type
Description

Content-type

string

application/json

Authentication*

string

Bearer <access_token>. Access token retrieved from Authentication API

{
    id = 'id',
    name = 'name',
    description = 'description',
    attributes = [],
    "last_upload_job_id": null
}

List all sources for this tenant

GET https://env1.telm.ai/api/backend/{tenant}/configuration/source

Api to list all sources in a tenant

Path Parameters

Name
Type
Description

tenant*

string

Tenant Id

Headers

Name
Type
Description

Content-type

string

application/json

Authentication*

string

Bearer <access_token>. Access token is retrieved from Authentication API

[
    {
        id = 'id',
        name = 'name',
        description = 'description',
        attributes = [
            {
                "id": "<id>",
                "name": "<name>",
                "monitored": <true/false>,
                "status": "<status>",
                "model_last_updated": "<date>"
            },
            {
                "id": "<id>",
                "name": "<name>",
                "monitored": <true/false>,
                "status": "<status>",
                "model_last_updated": "<date>"
            }
        ],
        "last_upload_job_id": "<job-id>",
        "scheduled_upload": <scheduled_upload>
    }
]

Update a source

PUT https://env1.telm.ai/api/backend/{tenant}/configuration/sources

Create a new source in the tenant

Path Parameters

Name
Type
Description

tenant*

string

Tenant Id

Query Parameters

Name
Type
Description

name*

string

Name of source

description

string

Description of source

Headers

Name
Type
Description

Content-type

string

application/json

Authentication*

string

Bearer <access_token>. Access token retrieved from Authentication API

{
    id = 'id',
    name = 'name',
    description = 'description',
    attributes = [],
    "last_upload_job_id": null
}

Get details of a specific source

GET https://env1.telm.ai/api/backend/{tenant}/configuration/sources/<source-id>

Path Parameters

Name
Type
Description

source-id*

string

Id of source to be retrieved.

tenant*

string

Tenant id

Headers

Name
Type
Description

Content-type

string

application/json

Authorization*

string

Bearer <access_token from Authentication API>

{
    "id": "<source-id>",
    "name": "<source-name>",
    "description": "<source-description>",
    "attributes": [],
    "last_upload_job_id": null,
    "scheduled_upload": null
}

Delete Source

DELETE https://env1.telm.ai/api/backend/{tenant}/configuration/sources/<source-id>

Delete a specific source

Path Parameters

Name
Type
Description

source-id*

string

Id of source to be deleted. This can be retrieved by looking up a source by name

tenant*

string

Name of tenant

Headers

Name
Type
Description

Content-type

string

application/json

Authorization*

string

Bearer <access_token from Authentication API>

{
    "message": "Source was deleted successfully"
}
PreviousGet Google Service Account APINextUpload data from Cloud

Last updated 6 months ago