Data lakes

POST /v1/datalake
Description
Create a new data lake.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
name
string
yes
Friendly schema name
type
string
yes
aws
metadata
object
yes
object containing additional fields
⌞ aws_s3_bucket
string
yes
Bucket name
⌞ aws_s3_prefix
string
yes
Prefix to store parquet files under
⌞ aws_region
string
yes
AWS region (ie. us-east-1, us-west-2, etc.)
Example Response
{}
GET /v1/datalake
Description
Get a list of data lakes for a team.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Example Response
[
   {
      "id":"9c0837a8-4a29-4340-8af3-5cbf6d339a54",
      "type":"aws",
      "name":"Default DataLake",
      "team_id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
      "status":"active",
      "status_full":"",
      "archived":false,
      "inserted_at":"2021-03-14T23:42:12.109951Z",
      "updated_at":"2021-03-14T23:42:12.123369Z"
   }
]
GET /v1/datalake/{id}
Description
Get a data lake by lake_id
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
lake_id
string
yes
ID of the data lake you wish to retrieve
Example Response
{
   "id":"9c0837a8-4a29-4340-8af3-5cbf6d339a54",
   "type":"aws",
   "name":"Default DataLake",
   "team_id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
   "status":"active",
   "status_full":"",
   "archived":false,
   "inserted_at":"2021-03-14T23:42:12.109951Z",
   "updated_at":"2021-03-14T23:42:12.123369Z"
}
PUT /v1/datalake
Description
Update an existing data lake.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Body parameters
Param
Type
Required
Description
TODO
string
yes
N/A

Schemas

Destinations

Last modified 1yr ago

Param	Type	Required	Description
`Authorization`	string	yes	Bearer token containing API key