v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Templates

Bucket Templates

Instantiate Bucket Template

Instantiate bucket template.

post/v1/templates/buckets/{template_id}/instantiate

Path parameters

template_idstring required

Template ID

Request body

bucket_namestring required

Name for the new bucket

descriptionstring nullable

Optional description override for the bucket

Example request

{
  "bucket_name": "my_product_images",
  "description": "Product images for e-commerce store"
}

Response

Successful Response

bucket_idstring required

ID of the created bucket

bucket_namestring required

Name of the created bucket

template_idstring required

ID of the template used

statusstring

Status of the instantiation

created_atstring date-time

Timestamp when bucket was created

Example response

{
  "bucket_id": "bkt_abc123",
  "bucket_name": "my_product_images",
  "created_at": "2025-01-15T12:00:00Z",
  "status": "created",
  "template_id": "tmpl_image_bucket"
}