StediDOCS

Buckets

Stedi Buckets service.

Download OpenAPI

ListBuckets

GET/buckets
Retrieve a list containing every bucket.
Parameters
pageSize
Optionalquery
Limit response to this number of resources. Default to 25.
pageToken
Optionalquery
The value of token returned in prior request (used for pagination).

Example

GET
https://buckets.cloud.us.stedi.com/2022-05-05/buckets?pageSize=45&pageToken=...

CreateBucket

POST/buckets
Create a new bucket.
Request body

application/json

bucketName
Requiredstring

Bucket identifier. Be aware that the bucket namespace is shared across all customers, and try to pick a name that is not likely to already be in use.

notifications
Optionalobject

[EXPERIMENTAL FEATURE] Describes the notification configuration for a Stedi bucket.

BucketNotificationConfigurations object.

Example

POST
https://buckets.cloud.us.stedi.com/2022-05-05/buckets

ReadBucket

GET/buckets/{bucketName}
Retrieve an existing bucket.
Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$

Example

GET
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/2ylpgn

UpdateBucket

PUT/buckets/{bucketName}
Update a bucket.
Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
Request body

application/json

notifications
Optionalobject

[EXPERIMENTAL FEATURE] Describes the notification configuration for a Stedi bucket.

BucketNotificationConfigurations object.

Example

PUT
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/hsu3

DeleteBucket

DELETE/buckets/{bucketName}
Delete a bucket. Bucket must be empty.
Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$

Example

DELETE
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/t7cc

ListObjects

GET/buckets/{bucketName}/objects
Retrieve a list containing every object.
Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
pageSize
Optionalquery
Limit response to this number of resources. Default to 25.
pageToken
Optionalquery
The value of token returned in prior request (used for pagination).

Example

GET
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/m/objects?pageSize=13&pageToken=...

GetObject

GET/buckets/{bucketName}/objects/{key}

Retrieves an object from a bucket.

[IMPORTANT] This operation is currently only supported through the SDK. Direct API calls will fail.

Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
key
Requiredpath

Example

GET
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/ku/objects/...

PutObject

PUT/buckets/{bucketName}/objects/{key}

Writes an object to a bucket.

[IMPORTANT] This operation is currently only supported through the SDK. Direct API calls will fail.

Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
key
Requiredpath
Request body

application/octet-stream

Requiredstring

body
Requiredapplication/octet-stream

Binary representation of the file

Example

PUT
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/0d1g/objects/...

DeleteObject

DELETE/buckets/{bucketName}/objects/{key}
Delete an existing object.
Parameters
bucketName
Requiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
key
Requiredpath

Example

DELETE
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/bk-i/objects/...