Storage Buckets¶
Important
Full S3-Compatible API Access — Coming Soon.
Direct S3-compatible API access (AWS SDK, s3cmd, rclone, etc.) for Skip2
storage buckets is currently on our roadmap. The endpoints below let you manage
bucket configuration via the Skip2 API; raw S3-protocol object operations will
be available in a future release. Follow our changelog or
contact support to be notified when it
launches.
Storage buckets provide S3-compatible object storage served over the Skip2 CDN. The API manages the configuration of existing buckets. Provisioning a new bucket (which allocates backing object storage) is performed from the dashboard.
Endpoints¶
Method |
Path |
Description |
|---|---|---|
|
|
List buckets |
|
|
Retrieve a bucket |
|
|
Update a bucket |
|
|
Soft-delete a bucket |
List buckets¶
curl https://api.skip2.net/v1/storage/buckets \
-H "Authorization: Bearer $SKIP2_API_KEY"
{
"success": true,
"data": [
{
"id": 1000, "name": "assets", "full_bucket_name": "assets.skip2",
"provider": "tigris", "region": "auto",
"s3_endpoint": "assets.skip2userobjects.com",
"custom_subdomain": null, "cache_ttl": "86400",
"size_bytes": 10485760, "enabled": true,
"created": "2023-01-01T00:00:00"
}
]
}
Update a bucket (partial)¶
Updatable fields are cache_ttl and custom_subdomain. Other fields in the
body are ignored and reported in meta.ignored_fields.
curl -X PATCH https://api.skip2.net/v1/storage/buckets/1000 \
-H "Authorization: Bearer $SKIP2_API_KEY" \
-H "Content-Type: application/json" \
-d '{"cache_ttl": "3600"}'
Delete a bucket¶
curl -X DELETE https://api.skip2.net/v1/storage/buckets/1000 \
-H "Authorization: Bearer $SKIP2_API_KEY"
Soft-deleted buckets are retained for a grace period before removal.