Home /  API Reference / 

Buckets

Stedi Buckets service.

Download OpenAPI

CopyObject

POST/copy

Copies an object that already exists in a bucket.

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

Request body

application/json

bucketNameRequiredstring
Destination bucket.
copySourceOptionalstring
Source object for the copy operation. The source bucket name and key, separated by a forward slash (/).
keyRequiredstring
Destination object key.

Example

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

ListBuckets

GET/buckets
Retrieve a list containing every bucket.
Parameters
pageSizeOptionalquery
The maximum number of elements to return in a page
pageTokenOptionalquery
The token used for pagination

Example

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

CreateBucket

POST/buckets
Create a new bucket.
Request body

application/json

bucketNameRequiredstring

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.

notificationsOptionalobject
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
bucketNameRequiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$

Example

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

UpdateBucket

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

application/json

notificationsOptionalobject
Describes the notification configuration for a Stedi bucket.
BucketNotificationConfigurations object.

Example

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

DeleteBucket

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

Example

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

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
bucketNameRequiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
keyRequiredpath

Example

GET
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/g/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
bucketNameRequiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
keyRequiredpath
Request body

application/octet-stream

Requiredstring

bodyRequiredapplication/octet-stream

Binary representation of the file

Example

PUT
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/d-2/objects/...

DeleteObject

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

Example

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

ListObjects

GET/buckets/{bucketName}/objects
Retrieve a list containing every object.
Parameters
bucketNameRequiredpath
The name of the Stedi bucket Pattern: ^[a-z0-9-]+$
prefixOptionalquery
delimiterOptionalquery
pageSizeOptionalquery
The maximum number of elements to return in a page
pageTokenOptionalquery
The token used for pagination

Example

GET
https://buckets.cloud.us.stedi.com/2022-05-05/buckets/2/objects?prefix=...&delimiter=...&pageSize=1&pageToken=...

Feedback

Have an idea for something we could improve? Page not clear? We love feedback - send us a message.

Stedi

Build EDI integrations fast, without being an EDI expert

Start building
About
ProductPricingCareersContactBlog
Documentation
CoreGuidesFunctionsAll DocsChangelog
Resources
EDI ReferenceEDI InspectorEDI Guide CatalogEDI Forum
Follow
  1. Twitter
  2. GitHub
Backed by
AdditionBloomberg BetaFirst RoundStripeUSV
Loading status...
Customer AgreementService TermsPrivacy Notice

Stedi is a registered trademark of Stedi, Inc. All names, logos, and brands of third parties listed on our site are trademarks of their respective owners (including “X12”, which is a trademark of X12 Incorporated). Stedi, Inc. and its products and services are not endorsed by, sponsored by, or affiliated with these third parties. Our use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.