Skip to main content

​
list

List all storage configurations. 
client.storage_configs.list(
    limit=10,
    cursor="abc123"
)
​
limit
int
Maximum number of items to return per page
​
cursor
str
Pagination cursor for fetching the next page
​
data
List[StorageConfig]
List of storage configuration objects
​
next_cursor
str | None
Cursor for the next page, or None if no more results

​
create

Create a new storage configuration. 
# S3 configuration
client.storage_configs.create(
    name="Production S3",
    provider="s3",
    s3_bucket_name="my-bucket",
    s3_bucket_region="us-east-1",
    s3_access_key_id="AKIAIOSFODNN7EXAMPLE",
    s3_secret_access_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
)

# Google Cloud Storage configuration
client.storage_configs.create(
    name="GCS Bucket",
    provider="gcs",
    gc_storage_bucket_name="my-gcs-bucket",
    gc_storage_auth_json_content='{"type": "service_account", ...}'
)
​
name
str
required
Name for this storage configuration
​
provider
str
required
Storage provider type (e.g., “s3”, “gcs”)
​
s3_bucket_name
str
S3 bucket name (required for S3 provider)
​
s3_bucket_region
str
S3 bucket region (e.g., “us-east-1”)
​
s3_bucket_prefix
str
Prefix/folder path within the S3 bucket
​
s3_access_key_id
str
AWS access key ID for authentication
​
s3_secret_access_key
str
AWS secret access key for authentication
​
s3_is_accelerated
bool
Enable S3 transfer acceleration
​
gc_storage_bucket_name
str
Google Cloud Storage bucket name (required for GCS provider)
​
gc_storage_prefix
str
Prefix/folder path within the GCS bucket
​
gc_storage_auth_json_content
str
JSON content of the GCS service account key
​
uid
str
Unique identifier for the storage configuration
​
name
str
Name of the storage configuration
​
provider
str
Storage provider type

​
test

Test a storage configuration to verify connectivity and credentials. 
client.storage_configs.test("sc_abc123")
​
uid
str
required
Unique identifier of the storage configuration to test
​
success
bool
Whether the test was successful
​
message
str
Test result message or error details

​
delete

Delete a storage configuration. 
client.storage_configs.delete("sc_abc123")
​
uid
str
required
Unique identifier of the storage configuration to delete

Build docs developers (and LLMs) love

Get started for freeTalk to us