Skip to content

Added documentation for case sensitivity/insensitivity in the S3 api #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 7, 2025
Merged

Added documentation for case sensitivity/insensitivity in the S3 api #313

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6aadf00
Update s3-api.mdx
therealadityashankar Jul 5, 2025
fa847fc
Update s3-api.mdx
muhsinking Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions serverless/storage/s3-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,14 @@ Core AWS CLI operations such as `ls`, `cp`, `mv`, `rm`, and `sync` function as e

## s3 CLI examples

When using `aws s3` commands, you must pass in the [endpoint URL](#datacenter-availability) for your network volume using the `--endpoint-url` flag.
When using `aws s3` commands, you must pass in the [endpoint URL](#datacenter-availability) for your network volume using the `--endpoint-url` flag and the datacenter ID using the `--region` flag.

<Note>
<Warning>
The `--region` flag is case-sensitive. For instance, `--region EU-RO-1` is a valid input, whereas `--region eu-ro-1` will be rejected.
</Warning>

<Note>
Unlike traditional S3 key-value stores, object names in the Runpod S3-compatible API correspond to actual file paths on your network volume. Object names containing special characters (e.g., `#`) may need to be URL encoded to ensure proper processing.

</Note>

### List objects
Expand All @@ -95,11 +97,11 @@ aws s3 ls --region [DATACENTER] \
Unlike standard S3 buckets, `ls` and `ListObjects` operations will list empty directories.

<Warning>

`ls` operations may take a long time when used on a directory containing many files (over 10,000) or large amounts of data (over 10GB), or when used recursively on a network volume containing either.

</Warning>



### Transfer files

Use `cp` to copy a file to a network volume:
Expand Down