How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightdash Organization Warehouse Credentials API

The Organization Warehouse Credentials API from Lightdash — 2 operation(s) for organization warehouse credentials.

Lightdash Organization Warehouse Credentials API is one of 50 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Organization Warehouse Credentials. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 108 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

5 operations 2 paths 108 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.3156.1
Base URL
https://app.lightdash.cloud
Authentication
API Key, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash Organization Warehouse Credentials API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as connect.sid (session_cookie). An API key is passed in the header as Authorization (api_key).

  • api_key — Value should be 'ApiKey '

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Organization Warehouse Credentials 5
GET
/api/v1/org/warehouse-credentials
List warehouse credentials
ListOrganizationWarehouseCredentials 1 param → 200default
POST
/api/v1/org/warehouse-credentials
Create warehouse credentials
CreateOrganizationWarehouseCredentials body → 200default
GET
/api/v1/org/warehouse-credentials/{credentialsUuid}
Get warehouse credential
GetOrganizationWarehouseCredentials 1 param → 200default
PATCH
/api/v1/org/warehouse-credentials/{credentialsUuid}
Update warehouse credentials
UpdateOrganizationWarehouseCredentials 1 param body → 200default
DELETE
/api/v1/org/warehouse-credentials/{credentialsUuid}
Delete warehouse credentials
DeleteOrganizationWarehouseCredentials 1 param → 200default

Schemas 108

The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are CreateSnowflakeCredentials (25 properties), Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__ (22 properties), Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__ (19 properties), Pick_CreateRedshiftCredentials.Exclude_keyofCreateRedshiftCredentials.SensitiveCredentialsFieldNames__ (18 properties). Each schema is shown below with its type and property counts.

DucklakeDataPathGcs
CreateDucklakeDataPath
TrinoCredentials
Pick_CreateDucklakeDataPathS3.Exclude_keyofCreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey__
object
From T, pick a set of properties whose keys are in the union K
6 properties 2 required
DucklakeCatalogSqlite
DuckdbDucklakeCredentials
Omit_CreateDatabricksCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DucklakeCatalogType.POSTGRES
string
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
Omit_CreateDucklakeDataPathAzure.connectionString-or-accountKey_
Construct a type with the properties of T except for those in type K.
WarehouseTypes.BIGQUERY
string
OrganizationWarehouseCredentialsSummary
DucklakeDataPathType.AZURE
string
WarehouseTypes.REDSHIFT
string
DucklakeDataPathAzure
SnowflakeAuthenticationType
string
Omit_CreateDucklakeCatalogPostgres.user-or-password_
Construct a type with the properties of T except for those in type K.
BigqueryAuthenticationType
string
DucklakeDataPathS3
CreateDuckdbCredentials
Pick_CreateClickhouseCredentials.Exclude_keyofCreateClickhouseCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
9 properties 4 required
WarehouseTypes.ATHENA
string
DucklakeCatalogType.SQLITE
string
RedshiftCredentials
Omit_CreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
SslConfiguration
object
7 properties
CreateDatabricksCredentials
object
15 properties 4 required
DucklakeDataPathType.GCS
string
AthenaCredentials
ClickhouseCredentials
CreateOrganizationWarehouseCredentials
object
3 properties 2 required
Omit_CreateRedshiftCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DucklakeCatalogDuckdb
CreateDucklakeDataPathAzure
object
5 properties 2 required
Omit_CreateSnowflakeCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
Pick_OrganizationWarehouseCredentials.organizationWarehouseCredentialsUuid-or-name-or-description-or-warehouseType_
object
From T, pick a set of properties whose keys are in the union K
4 properties 4 required
WarehouseTypes.DATABRICKS
string
Pick_CreateDuckdbMotherduckCredentials.Exclude_keyofCreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
8 properties 4 required
Omit_CreateBigqueryCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
AthenaAuthenticationType
string
Omit_CreateDuckdbDucklakeCredentials.catalog-or-dataPath_
Construct a type with the properties of T except for those in type K.
Omit_CreateClickhouseCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
Omit_CreateAthenaCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
CreateAthenaCredentials
object
17 properties 5 required
CreateTrinoCredentials
object
12 properties 8 required
DatabricksAuthenticationType
string
CreateDucklakeCatalogSqlite
object
2 properties 2 required
CreateWarehouseCredentials
CreateDucklakeCatalogPostgres
object
6 properties 6 required
Pick_CreateDucklakeDataPathAzure.Exclude_keyofCreateDucklakeDataPathAzure.connectionString-or-accountKey__
object
From T, pick a set of properties whose keys are in the union K
3 properties 2 required
Pick_CreateDuckdbDucklakeCredentials.Exclude_keyofCreateDuckdbDucklakeCredentials.catalog-or-dataPath__
object
From T, pick a set of properties whose keys are in the union K
8 properties 3 required
DucklakeDataPathLocal
CreateSnowflakeCredentials
object
25 properties 6 required
ApiOrganizationWarehouseCredentialsSummaryListResponse
object
2 properties 2 required
WarehouseTypes.TRINO
string
Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
19 properties 5 required
CreateDucklakeCatalogDuckdb
object
2 properties 2 required
AnyType
This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are onl…
Pick_CreateBigqueryCredentials.Exclude_keyofCreateBigqueryCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
15 properties 3 required
CreateDucklakeDataPathS3
object
8 properties 2 required
ApiSuccessEmpty
object
2 properties 1 required
Omit_CreateTrinoCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DucklakeDataPathType.S3
string
CreateDucklakeCatalog
DuckdbMotherduckCredentials
Pick_CreateDucklakeDataPathGcs.Exclude_keyofCreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret__
object
From T, pick a set of properties whose keys are in the union K
2 properties 2 required
UpdateOrganizationWarehouseCredentials
object
3 properties
Omit_CreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey_
Construct a type with the properties of T except for those in type K.
DucklakeCatalog
CreatePostgresCredentials
Pick_CreateTrinoCredentials.Exclude_keyofCreateTrinoCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
10 properties 6 required
Pick_CreateRedshiftCredentials.Exclude_keyofCreateRedshiftCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
18 properties 5 required
WarehouseTypes
string
DucklakeDataPathType.LOCAL
string
DucklakeCatalogType.DUCKDB
string
WarehouseTypes.SNOWFLAKE
string
ApiOrganizationWarehouseCredentialsResponse
object
2 properties 2 required
CreateDuckdbDucklakeCredentials
object
10 properties 5 required
DucklakeCatalogPostgres
CreateBigqueryCredentials
object
16 properties 4 required
Omit_CreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret_
Construct a type with the properties of T except for those in type K.
DuckdbConnectionType.DUCKLAKE
string
DuckdbCredentials
CreateRedshiftCredentials
Omit_CreatePostgresCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
WarehouseTypes.POSTGRES
string
CreateClickhouseCredentials
object
11 properties 6 required
Pick_CreateDatabricksCredentials.Exclude_keyofCreateDatabricksCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
10 properties 4 required
WarehouseTypes.CLICKHOUSE
string
Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
22 properties 5 required
WarehouseCredentials
CreateDuckdbMotherduckCredentials
object
9 properties 5 required
DuckdbConnectionType.MOTHERDUCK
string
PostgresCredentials
Pick_CreateDucklakeCatalogPostgres.Exclude_keyofCreateDucklakeCatalogPostgres.user-or-password__
object
From T, pick a set of properties whose keys are in the union K
4 properties 4 required
SnowflakeCredentials
WarehouseTypes.DUCKDB
string
ApiOrganizationWarehouseCredentialsListResponse
object
2 properties 2 required
Record_string.string_
object
Construct a type with a set of properties K of type T
BigqueryCredentials
DatabricksCredentials
CreateDucklakeDataPathGcs
object
4 properties 2 required
OrganizationWarehouseCredentials
object
Organization-level warehouse credentials
8 properties 8 required
DucklakeDataPath
WeekDay
number
Pick_CreateAthenaCredentials.Exclude_keyofCreateAthenaCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
15 properties 5 required
SshTunnelConfiguration
object
6 properties
CreateDucklakeDataPathLocal
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-organization-warehouse-credentials-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
Where this information came from

This is an independent, third-party profile of Lightdash Organization Warehouse Credentials API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.