Skip to main content
POST
/
v0
/
stores
Create a store
curl --request POST \
  --url https://api.pixxel.space/v0/stores \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "my-analysis-store",
  "type": "S3",
  "configs": {
    "bucket": "my-data-bucket",
    "region": "us-east-2",
    "path_prefix": "data/processed/"
  },
  "secrets": {},
  "labels": {
    "env": "prod",
    "team": "data"
  }
}'
{
  "id": "576d8241-6e78-40ad-b3e6-295edbfe71f5",
  "name": "my-analysis-store",
  "type": "S3",
  "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"
}
📚 View developer guide to learn more

Authorizations

​
Authorization
string
header
required

Body

application/json

Create Store

​
name
string
required

Unique user friendly name for easier identification

Example:

"my-analysis-store"

​
type
enum<string>
required

Type of bucket depending on the cloud provider. Currently Supported - S3, AZBLOB, GCS

Available options:
S3,
GCS,
AZBLOB
Example:

"S3"

​
configs
object
required
​
secrets
object
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

​
labels
object

User defined labels for metadata

Example:
{ "env": "prod", "team": "data" }

Response

OK

​
id
string

Identifier to be used while transferring data

Example:

"576d8241-6e78-40ad-b3e6-295edbfe71f5"

​
name
string

Unique user friendly name for easier identification

Example:

"my-analysis-store"

​
type
enum<string>

Type of bucket depending on the cloud provider. Currently Supported - S3, AZBLOB, GCS

Available options:
S3,
GCS,
AZBLOB
Example:

"S3"

​
configs
object
​
labels
object

User defined labels for metadata

Example:
{ "env": "prod", "team": "data" }
​
created_at
string

Store creation time

Example:

"2024-03-20T15:04:05Z"

​
updated_at
string

Store last updated time

Example:

"2024-03-20T15:04:05Z"

​
created_by
string

Identifier of the user that created store

Example:

"ea2a79fc-6f68-40d7-8b79-18195bf74872"