Protobox Docs
  • Protobox Overview
    • 🐝What is Protobox?
  • Installation
  • Getting Started
  • API DOCUMENTATION
    • 🪣S3-Compatible API
  • Dev tools and SDKs
    • 💻CLI
    • 🧰SDKs
      • Using AWS S3 SDK
  • Resources
    • 📖Glossary
    • 🔗External References
    • ❔FAQ
  • Protobox Twitter
  • Protobox Github
  • Swarm Discord
Powered by GitBook
On this page
  • API Endpoint
  • Supported API Actions
  1. API DOCUMENTATION

S3-Compatible API

PreviousGetting StartedNextCLI

Last updated 2 years ago

API Endpoint

The Protobox S3-compatible API endpoint URL is: 

https://s3.protobox.xyz

Supported API Actions

Protobox currently supports the following S3 API actions:

Action
Function

CreateBucket

Creates a new S3 bucket. See for bucket naming conventions.

DeleteBucket

Deletes the S3 bucket. All objects in a bucket must be deleted before the bucket itself can be deleted.

DeleteObject

Removes the specified object.

GetObject

Retrieves objects from S3.

HeadObject

This command will return the metadata of the file if it exists. If the file does not exist, the command will return an error message.

ListBuckets

Lists all of the buckets you own.

ListObjects

Returns some or all (up to 1,000) of the objects in a bucket.

PutObject

Adds an object to a specifed bucket.

Additional documentation regarding the topics mentioned on this page can be found via our .

If you need assistance or have feature suggestions, please reach out to us at team@protobox.xyz

🪣
External References
here