Lightup Datasources API
The Datasources API from Lightup — 3 operation(s) for datasources.
OpenAPI Specification
openapi: 3.1.0
info:
description: Lightup Metrics API provides CRUD interface to Dashboard objects.
title: Lightup Dashboard API Credentials Datasources API
version: 1.0.0
servers:
- description: Enter your Lightup subdomain
url: https://app.{clusterId}.lightup.ai
variables:
clusterId:
default: demo
tags:
- name: Datasources
paths:
/api/{api_version}/ws/{workspace_id}/sources/:
get:
description: List all datasources
parameters:
- description: ''
explode: true
in: path
name: api_version
required: true
schema:
allOf:
- description: An enumeration.
enum:
- v1
title: ApiVersion
type: string
default: v1
title: api_version
- description: UUID of the workspace; visible in the workspace URL.
explode: true
in: path
name: workspace_id
required: true
schema:
description: UUID of the workspace; visible in the workspace URL.
title: workspace_id
type: string
- description: Return sources from offset
explode: true
in: query
name: offset
required: false
schema:
description: Return sources from offset
title: offset
type: integer
- description: Return only limit number of datasources
explode: true
in: query
name: limit
required: false
schema:
description: Return only limit number of datasources
title: limit
type: integer
- description: 'Input ''Bearer _access-token_''. To obtain access token, see API, API Credentials: Get access token.'
explode: true
in: header
name: authorization
required: true
schema:
description: 'Input ''Bearer _access-token_''. To obtain access token, see API, API Credentials: Get access token.'
title: authorization
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema'
type: array
description: ''
summary: Get datasource list
tags:
- Datasources
post:
description: Create a new datasource
parameters:
- description: ''
explode: true
in: path
name: api_version
required: true
schema:
allOf:
- description: An enumeration.
enum:
- v1
title: ApiVersion
type: string
default: v1
title: api_version
- description: UUID of the workspace; visible in the workspace URL.
explode: true
in: path
name: workspace_id
required: true
schema:
description: UUID of the workspace; visible in the workspace URL.
title: workspace_id
type: string
- description: 'Input ''Bearer _access-token_''. To obtain access token, see API, API Credentials: Get access token.'
explode: true
in: header
name: authorization
required: true
schema:
description: 'Input ''Bearer _access-token_''. To obtain access token, see API, API Credentials: Get access token.'
title: authorization
type: string
requestBody:
content:
application/json:
schema:
definitions:
AlertChannelConfig:
properties:
channelId:
description: UUID of the alert channel
title: Channelid
type: string
required:
- channelId
title: AlertChannelConfig
type: object
AlertConfig:
properties:
channels:
default: []
description: List of alertchannels
items:
$ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/AlertChannelConfig'
title: Channels
type: array
isMuted:
default: true
description: If true, no notifications are sent on this channel
title: Ismuted
type: boolean
mutingSchedules:
default: []
description: If schedule is set, no notifications are sent on this channel during schedule
items:
type: string
title: Mutingschedules
type: array
title: AlertConfig
type: object
ApiVersion:
description: An enumeration.
enum:
- v1
title: ApiVersion
type: string
AthenaConfig:
examples:
- awsAccessKeyId: ABC123
awsSecretAccessKey: '********'
regionName: us-west-2
s3StagingDir: s3://abc/123
type: athena
properties:
awsAccessKeyId:
title: Awsaccesskeyid
type: string
awsSecretAccessKey:
title: Awssecretaccesskey
type: string
regionName:
title: Regionname
type: string
s3StagingDir:
title: S3Stagingdir
type: string
type:
default: athena
enum:
- athena
title: Type
type: string
workgroup:
title: Workgroup
type: string
required:
- regionName
- s3StagingDir
- awsAccessKeyId
- awsSecretAccessKey
title: AthenaConfig
type: object
AzureBlobStorageConfig:
examples:
- accountKey: '******'
accountName: lightup_test
properties:
accountKey:
title: Accountkey
type: string
accountName:
title: Accountname
type: string
type:
default: azureblobstorage
enum:
- azureblobstorage
title: Type
type: string
required:
- accountName
title: AzureBlobStorageConfig
type: object
BigqueryConfig:
examples:
- serviceAccountInfo: '********'
type: bigquery
properties:
serviceAccountInfo:
title: Serviceaccountinfo
type: string
type:
default: bigquery
enum:
- bigquery
title: Type
type: string
required:
- serviceAccountInfo
title: BigqueryConfig
type: object
DatabricksConfig:
examples:
- apiPort: 15001
clusterId: cluster-id
dbfsPrefix: dbfs://vendors/lightupdata/
httpPath: sql/protocolv1/o/xxx/xxx
token: '********'
type: databricks
workspaceUrl: example.com
properties:
apiPort:
default: 15001
title: Apiport
type: integer
catalog:
description: Specify catalog to scan
title: Catalog
type: string
clusterId:
title: Clusterid
type: string
dbfsPrefix:
title: Dbfsprefix
type: string
httpPath:
title: Httppath
type: string
token:
title: Token
type: string
type:
default: databricks
enum:
- databricks
title: Type
type: string
workspaceUrl:
title: Workspaceurl
type: string
required:
- token
- workspaceUrl
- httpPath
title: DatabricksConfig
type: object
DremioConfig:
examples:
- dbname: Default
disable_certificate_verification: false
host: 35.226.49.39
password: '********'
port: 32010
type: dremio
use_encryption: false
user: root
properties:
disableCertificateVerification:
default: false
title: Disablecertificateverification
type: boolean
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 32010
title: Port
type: integer
type:
default: dremio
enum:
- dremio
title: Type
type: string
useEncryption:
default: true
title: Useencryption
type: boolean
user:
title: User
type: string
required:
- host
- user
- password
title: DremioConfig
type: object
EventRuleConfig:
properties:
alertConfig:
allOf:
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/AlertConfig'
default:
channels: []
isMuted: true
mutingSchedules: []
title: Alertconfig
enabled:
default: false
title: Enabled
type: boolean
title: EventRuleConfig
type: object
GreenplumConfig:
examples:
- dbname: cdb
host: cdb.demo.lightup.ai
password: '********'
port: 5432
type: greenplum
user: postgres
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 5432
title: Port
type: integer
type:
default: greenplum
enum:
- greenplum
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- dbname
- password
title: GreenplumConfig
type: object
HanaConfig:
examples:
- host: dd10a0a2-52b4-464a-9983-71cc47a718dd.hana.trial-us10.hanacloud.ondemand.com
password: '********'
port: 443
sslValidateCertificate: false
type: hana
user: DBADMIN
properties:
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 443
title: Port
type: integer
sslValidateCertificate:
default: true
description: Whether to allow validation of the host's certificate
title: Sslvalidatecertificate
type: boolean
type:
default: hana
enum:
- hana
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- password
title: HanaConfig
type: object
HiveAuthType:
description: An enumeration.
enum:
- noAuth
- kerberos
- ldap
title: HiveAuthType
type: string
HiveConfig:
examples:
- authType: kerberos
host: localhost
krbAuthenticationServerDomains:
- .ad-domain.internal
krbAuthenticationServerHostname: active-directory-service.ad-domain.internal
krbAuthenticationServerIp: 1.2.3.4
krbAuthenticationServerRealm: AD-REALM
krbHiveDomains:
- .hive-domain.internal
krbHiveHostname: hive-cluster-m.hive-domain.internal
krbHiveRealm: HIVE-REALM
krbKeytabFileBase64String: QUJDREUxMjM0NWFiY2RlCg==
krbPrincipal: test-user@AD-REALM
port: 11000
type: hive
properties:
authType:
allOf:
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/HiveAuthType'
default: noAuth
host:
title: Host
type: string
krbAuthenticationServerDomains:
items:
type: string
title: Krbauthenticationserverdomains
type: array
krbAuthenticationServerHostname:
title: Krbauthenticationserverhostname
type: string
krbAuthenticationServerIp:
title: Krbauthenticationserverip
type: string
krbAuthenticationServerRealm:
title: Krbauthenticationserverrealm
type: string
krbHiveDomains:
items:
type: string
title: Krbhivedomains
type: array
krbHiveHostname:
title: Krbhivehostname
type: string
krbHiveRealm:
title: Krbhiverealm
type: string
krbKeytabFileBase64String:
title: Krbkeytabfilebase64String
type: string
krbPrincipal:
title: Krbprincipal
type: string
password:
default: default
title: Password
type: string
port:
default: 10000
title: Port
type: integer
serviceName:
title: Servicename
type: string
type:
default: hive
enum:
- hive
title: Type
type: string
user:
title: User
type: string
required:
- host
title: HiveConfig
type: object
IncortaConfig:
examples:
- dbname: Default
host: partner-lightup.sqli.cloud4.incorta.com
password: '********'
port: 6526
type: incorta
user: yi@lightup.ai
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 6526
title: Port
type: integer
type:
default: incorta
enum:
- incorta
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- dbname
- password
title: IncortaConfig
type: object
MicrosoftSqlConfig:
examples:
- dbname: cdb
host: demo.microsoftsql.lightup.ai
password: '********'
port: 1433
type: microsoftsql
user: test
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 1433
title: Port
type: integer
type:
default: microsoftsql
enum:
- microsoftsql
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- dbname
- password
title: MicrosoftSqlConfig
type: object
MySqlConfig:
examples:
- dbname: cdb
host: demo.mysql.lightup.ai
password: '********'
port: 3306
type: mysql
user: test
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 3306
title: Port
type: integer
type:
default: mysql
enum:
- mysql
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- dbname
- password
title: MySqlConfig
type: object
OracleConfig:
examples:
- dbname: database
host: oracledb.lightup.ai
password: '********'
port: 1521
type: oracle
user: test
- host: oracledb.lightup.ai
password: '********'
port: 1521
service: serviceSoon
type: oracle
user: test
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 1521
title: Port
type: integer
service:
title: Service
type: string
type:
default: oracle
enum:
- oracle
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- password
title: OracleConfig
type: object
PostgresConfig:
examples:
- dbname: cdb
host: cdb.demo.lightup.ai
password: '********'
port: 5432
type: postgres
user: postgres
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 5432
title: Port
type: integer
type:
default: postgres
enum:
- postgres
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- dbname
- password
title: PostgresConfig
type: object
ProfilerEventConfig:
properties:
enabled:
default: false
description: Enable generation of event
title: Enabled
type: boolean
monitoring:
allOf:
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/EventRuleConfig'
default:
alertConfig:
channels: []
isMuted: true
mutingSchedules: []
enabled: false
description: Enable generation of incidents and notifications
title: Monitoring
title: ProfilerEventConfig
type: object
RedshiftConfig:
examples:
- dbname: lightup
host: lightup-data.chtomx8ijp4o.us-west-2.redshift.amazonaws.com
password: '********'
port: 5439
type: redshift
user: awsuser
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
port:
default: 5439
title: Port
type: integer
serverless:
default: false
title: Serverless
type: boolean
type:
default: redshift
enum:
- redshift
title: Type
type: string
user:
title: User
type: string
required:
- host
- user
- dbname
- password
title: RedshiftConfig
type: object
S3BucketConfig:
examples:
- awsAccessKeyId: XPTO123
awsSecretAccessKey: '********'
regionName: us-west-2
properties:
awsAccessKeyId:
title: Awsaccesskeyid
type: string
awsSecretAccessKey:
title: Awssecretaccesskey
type: string
regionName:
title: Regionname
type: string
type:
default: s3bucket
enum:
- s3bucket
title: Type
type: string
title: S3BucketConfig
type: object
SnowflakeConfig:
examples:
- dbname: demo_db
host: nna54042
password: '********'
type: snowflake
user: lightup_test
properties:
dbname:
title: Dbname
type: string
host:
title: Host
type: string
password:
title: Password
type: string
role:
title: Role
type: string
type:
default: snowflake
enum:
- snowflake
title: Type
type: string
user:
title: User
type: string
warehouse:
title: Warehouse
type: string
required:
- host
- user
- dbname
- password
title: SnowflakeConfig
type: object
SourceConfig:
properties:
alationDatasourceId:
description: Configured Alation datasource id
exclusiveMinimum: 0
title: Alationdatasourceid
type: integer
atlanDatasourceId:
description: Configured Atlan datasource guid
title: Atlandatasourceid
type: string
connection:
description: Connection parameters for the datasource
oneOf:
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/AthenaConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/BigqueryConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/DatabricksConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/DremioConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/HanaConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/HiveConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/IncortaConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/MicrosoftSqlConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/MySqlConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/OracleConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/PostgresConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/RedshiftConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/SnowflakeConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/TeradataConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/GreenplumConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/AzureBlobStorageConfig'
- $ref: '#/paths/~1api~1%7Bapi_version%7D~1ws~1%7Bworkspace_id%7D~1sources~1/post/requestBody/content/application~1json/schema/definitions/S3BucketConfig'
title: Connection
governance:
allOf:
- $ref: '#/paths/~1
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightup/refs/heads/main/openapi/lightup-datasources-api-openapi.yml