--- title: "S3 Storage API Guide | Hostman Docs" description: "Learn how to use Hostman S3 Storage, including access credentials, AWS Signature V4 authentication, request signing, and supported bucket and object API methods." --- > For the complete documentation index for AI agents, see [llms.txt](https://hostman.com/llms.txt). A detailed guide on working with Hostman S3 Storage. ## Connection Credentials You can find S3 connection details in your Hostman dashboard. 1. Go to the [**S3 Storage**](https://my.hostman.com/storage) section. 2. Click on the bucket. 3. In the **Settings** tab, scroll down to see **S3 Parameters**. ![1cac3c1a 9cb3 4fce B15c Ec12634e9a78](https://content.hostman.com/assets/e2b1589a-f280-43b7-bbc4-cbeb32b8e632.png?width=1540&height=1596) We support AWS Signature V2 and AWS Signature V4. To authenticate the requester, all requests must be signed using a signature generated with an Access Key and Secret Key. ## Signature Calculation Signature calculation consists of three steps: 1. Obtaining the signing key 2. Generating the string to sign 3. Signing the string using the key #### Obtaining the Signing Key To get the signing key, encode the following data using the HMAC-SHA256 algorithm: ```shell DateKey = HMAC-SHA256("AWS4" + "", "") DateRegionKey = HMAC-SHA256(, "") DateRegionServiceKey = HMAC-SHA256(, "") SigningKey = HMAC-SHA256(, "aws4_request") ``` We support request signing using the Authorization HTTP header. Using the Authorization header is the most common method for user authentication. **General Request Format:** ```shell Authorization: AWS4-HMAC-SHA256 Credential=12345_USER/20180524/us-2/s3/aws4_request, SignedHeaders=host;range;x-amz-date, Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024 ``` Where: - `AWS4-HMAC-SHA256`: AWS Signature Version 4 (AWS4) and the signature algorithm (HMAC-SHA256) - `Credential`: Contains the access key and request information in the format: `${ACCESS_KEY}/${YYYYMMDD}/${REGION}/s3/aws4_request` - `SignedHeaders`: Lowercase list of header names used in the signature computation - `Signature`: The signed hash, consisting of the request body hash, secret key, and request information (canonical request) ## Generating the String to Sign To generate the string to sign, create a canonical request in the following format: ```shell \n \n \n \n \n ``` Where: - `HTTPMethod`: One of the HTTP methods such as GET, PUT, HEAD, DELETE - `CanonicalURI`: URI-encoded path starting after the domain with the first "/", e.g., for `https://s3.hmstorage.net/bucket/sample.txt` it would be `/bucket/sample.txt` - `CanonicalQueryString`: Request query parameters - `CanonicalHeaders`: List of headers and their values, separated by newline, in lowercase and without spaces - `SignedHeaders`: List of header names (no values), sorted alphabetically, in lowercase, separated by semicolons (e.g., `host;x-amz-content-sha256;x-amz-date`) - `HashedPayload`: SHA256 hash of the request body: `Hex(SHA256Hash())`. If there's no body, hash an empty string: `Hex(SHA256Hash(""))`. ## Signing the String Using the Key The string to sign is a concatenation of the following: ```shell "AWS4-HMAC-SHA256" + "\n" + timeStampISO8601Format + "\n" + + "\n" + Hex(SHA256Hash()) ``` Where: - `AWS4-HMAC-SHA256`: Defines the encryption algorithm in use - `timeStampISO8601Format`: Current UTC time in ISO 8601 format (e.g., `20130524T000000Z`) - `Scope`: Format: `date.Format() + "/" + + "/" + + "/aws4_request"`, e.g., `20130606/us-2/s3/aws4_request`. This binds the signature to a specific date, region, and service. When bound to a date, the signature is valid for 15 minutes. For more details on authentication via the `Authorization` header, refer to the official [Amazon S3 API documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html). ## Supported S3 Methods Hostman storage is compatible with AWS S3 methods: Bucket CRUD, Bucket Location, Object CRUD, Object Copy. Below are the main S3 methods supported by Hostman S3 storage. You can find a complete list of supported features in the [official CEPH documentation](https://docs.ceph.com/en/latest/radosgw/s3/#features-support). ### Bucket Methods | **Method** | **Description** | | --- | --- | | GET Service (List Buckets) | Get a list of buckets | | GET Bucket (List Objects) | Get list of objects in a bucket | | GET Bucket Location | Get the bucket's region | | DELETE Bucket | Delete a bucket | | HEAD Bucket | Get bucket status | | PUT Bucket | Create a new bucket | | GET Bucket ACL | Get access control list (ACL) | | PUT Bucket ACL | Set ACL | | GET Bucket Multipart Uploads | Get current multipart uploads | | PUT Bucket Versioning | Enable or suspend versioning | | GET Bucket Versioning | Get versioning status (returns nothing if never set) | | PUT Notification | Enable bucket event notifications | | DELETE Notification | Delete event notifications | | GET Notification | Get list of notifications | | GET Bucket Lifecycle | Get lifecycle configuration | | DELETE Bucket Lifecycle | Delete lifecycle configuration | | PUT Bucket Tagging | Add tags to the bucket | | GET Bucket Tagging | Get bucket tags | | DELETE Bucket Tagging | Remove bucket tags | | GET Bucket Policy | Get access policy | | PUT Bucket Policy | Set access policy | | DELETE Bucket Policy | Delete access policy | ### Object Methods | **Method** | **Description** | | --- | --- | | PUT Object | Create object | | PUT Object — Copy | Copy object | | DELETE Object | Delete object | | GET Object | Retrieve object | | HEAD Object | Get object metadata | | GET Object ACL | Get object ACL | | PUT Object ACL | Set object ACL | | POST Multipart Upload | Initiate multipart upload | | PUT Multipart Upload Part | Upload part of object | | GET Multipart Upload Parts | Get uploaded parts | | POST Multipart Upload (Complete) | Complete multipart upload | | DELETE Multipart Upload | Abort multipart upload | | PUT Object Tagging | Add tags to object | | GET Object Tagging | Get object tags | | DELETE Object Tagging | Remove object tags |