/api/configs/dataset#

Dataset config is used to configure dataset storage buckets and access.

Top-Level Configuration#

Field

Type

Description

Default Values

buckets

Bucket

Configuration for available dataset storage buckets.

{}

default_bucket

String

The default bucket identifier to use when none is specified.

None

Bucket#

Field

Type

Description

Default Values

dataset_path

String

The URI to the dataset storage location including protocol and bucket/container.

Required field

region

String

The cloud storage region where the bucket is located.

us-east-1

check_key

Boolean

Whether to validate access keys before allowing access to the bucket.

False

description

String

Human-readable description of the bucket and its intended use.

None

mode

String

Access mode for the bucket. Can be “read-only” or “read-write”.

read-write

default_credential

String/null

Default credential identifier to use for this bucket. If null, someone using the bucket will need to specify a credential.

None