You can list warehouses and retrieve one by its key. Add a warehouse and change its connection from the dashboard. Passwords and keys are never returned.

Endpoints

GET/v1/warehouses/{warehouse_key}

GET/v1/warehouses

Get a warehouse

Retrieve a warehouse by its key.

Endpoint

GET/v1/warehouses/{warehouse_key}

Path parameters

warehouse_key

string

The key of the warehouse to retrieve.

Query parameters

environment

string

The environment slug. When omitted, the account's default environment is used.

Returns

Warehouse

A warehouse is one database in your data warehouse that Knock reads from. Warehouses belong to the project and are shared by every environment.

connection_error

object(any)

The error from the last connection test, with a code and a message. Null when the last test passed.

connection_settings

object(any)

How Knock connects to the warehouse. The fields depend on the warehouse type, such as host, port, database, and username, or project_id, region, and service_account_email for BigQuery. Credentials such as passwords are never returned.

connection_status

enum(string)

The status of the warehouse's connection.

not_configuredkey_not_installedfailedconnectinguntestedconnected

created_at

string(date-time)

When the warehouse was created.

key

string

The unique key of the warehouse.

last_tested_at

string(date-time)

When the connection was last tested.

name

string

The name of the warehouse.

type

enum(string)

The type of data warehouse.

redshiftsnowflakepostgresbigquery

updated_at

string(date-time)

When the warehouse was last updated.

List warehouses

Returns a paginated list of the project's warehouses. Warehouses are shared by every environment.

Endpoint

GET/v1/warehouses

Query parameters

environment

string

The environment slug. When omitted, the account's default environment is used.

after

string

The cursor to fetch entries after.

before

string

The cursor to fetch entries before.

limit

integer

The number of entries to fetch per-page.

Returns

PaginatedWarehouseResponse

A paginated list of Warehouse. Contains a list of entries and page information.

entries

Warehouse[]

A list of entries.

connection_error

object(any)

The error from the last connection test, with a code and a message. Null when the last test passed.

connection_settings

object(any)

connection_status

enum(string)

Required

The status of the warehouse's connection.

not_configuredkey_not_installedfailedconnectinguntestedconnected

created_at

string(date-time)

Required

When the warehouse was created.

key

string

Required

The unique key of the warehouse.

last_tested_at

string(date-time)

When the connection was last tested.

name

string

Required

The name of the warehouse.

type

enum(string)

Required

The type of data warehouse.

redshiftsnowflakepostgresbigquery

updated_at

string(date-time)

Required

When the warehouse was last updated.

page_info

PageInfo

The information about a paginated result.

after

string

The cursor to fetch entries after. Will only be present if there are more entries to fetch.

before

string

The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.

page_size

integer

The number of entries to fetch per-page.

Warehouse

A warehouse is one database in your data warehouse that Knock reads from. Warehouses belong to the project and are shared by every environment.

Attributes

connection_error

object(any)

The error from the last connection test, with a code and a message. Null when the last test passed.

connection_settings

object(any)

connection_status

enum(string)

The status of the warehouse's connection.

not_configuredkey_not_installedfailedconnectinguntestedconnected

created_at

string(date-time)

When the warehouse was created.

key

string

The unique key of the warehouse.

last_tested_at

string(date-time)

When the connection was last tested.

name

string

The name of the warehouse.

type

enum(string)

The type of data warehouse.

redshiftsnowflakepostgresbigquery

updated_at

string(date-time)

When the warehouse was last updated.