website logo
Create accountLogin
Home
DCS
Node
Resources
Help center
Navigate through spaces
⌘K
Storj DCS
Get Started
AWS CLI and Hosted Gateway MT
AWS SDK and Hosted Gateway MT
Uplink CLI
Satellite Admin Console
Object Browser
Downloads
Download Uplink CLI
Download Self-hosted S3 Compatible Gateway
Download Storj Client Libraries
SDKs & Reference
Tutorial
How-to Guides
Concepts
Support
Support Overview
FAQ
Community Forum
Status Page
Help Desk
Billing, Payment & Accounts
Resources
Moved Documents
Docs powered by archbee 

ls

12min

List objects and prefixes or all buckets

Usage

Windows
Linux
MacOS
|
uplink ls [sj://BUCKET[/PREFIX]] [flags]


Flags

Flag

Description

--access string

the serialized access, or name of the access to use

--encrypted

if true, show paths as base64-encoded encrypted paths

--expanded, -x

Use expanded output, showing object expiration times and whether there is custom metadata attached

--help, -h

help for ls

--pending

if true, list incomplete objects instead

--recursive, -r

if true, list recursively

Examples

We consider the following object hierarchy throughout these examples:

Document image


We assume the object has been uploaded using a different encryption key than the other objects in the project.

List buckets

Windows
Linux
MacOS
|
uplink ls

Document image


List objects in a bucket

Windows
Linux
MacOS
|
uplink ls sj://images

Document image


List by prefix

Windows
Linux
MacOS
|
uplink ls sj://images/cakes

Document image


List recursively

Windows
Linux
MacOS
|
uplink ls --recursive 

Document image


List encrypted paths of all objects in a bucket

Windows
Linux
MacOS
|
uplink ls sj://recipes --encrypted

Document image


Notice that since sj://recipes/cakes/very-secret-recipe.txt was encrypted with a different key, we cannot view it using regular ls and the default access, but with --encrypted we can see that it is indeed stored in sj://recipes

Updated 22 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
import
NEXT
mb
Docs powered by archbee 
TABLE OF CONTENTS
Usage
Flags
Examples
List buckets
List objects in a bucket
List by prefix
List recursively
List encrypted paths of all objects in a bucket