Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Stores

Create a store

Create a store to export data to, under current workspace

post/v0/stores

Request body

namestring required

Unique user friendly name for easier identification

type'S3' | 'GCS' | 'AZBLOB' required
secretsobject required

Credentials to be used for transferring data to specified bucket These vary for each cloud provider - - S3 - access_key_id, secret_access_key - AZBLOB - account_name, tenant_id, client_id, client_secret - GCS - project_id, service_account_credentials

labelsobject

User defined labels for metadata

Example request

{
  "name": "my-analysis-store",
  "configs": {
    "bucket": "my-data-bucket",
    "region": "us-east-2",
    "path_prefix": "data/processed/"
  },
  "labels": {
    "env": "prod",
    "team": "data"
  }
}

Response

OK

idstring

Identifier to be used while transferring data

namestring

Unique user friendly name for easier identification

type'S3' | 'GCS' | 'AZBLOB'
labelsobject

User defined labels for metadata

created_atstring

Store creation time

updated_atstring

Store last updated time

created_bystring

Identifier of the user that created store

Example response

{
  "id": "576d8241-6e78-40ad-b3e6-295edbfe71f5",
  "name": "my-analysis-store",
  "configs": {
    "bucket": "my-data-bucket",
    "region": "us-east-2",
    "path_prefix": "data/processed/"
  },
  "labels": {
    "env": "prod",
    "team": "data"
  },
  "created_at": "2024-03-20T15:04:05Z",
  "updated_at": "2024-03-20T15:04:05Z",
  "created_by": "ea2a79fc-6f68-40d7-8b79-18195bf74872"
}