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 

Create an Access to an Object

9min

There are several ways to share access to an object:

  • by share
  • by Import an Access to an Object
  • by access restrict using Uplink CLI

Share an object

You can create an access using the uplink share command using Create an Access to an Object. For example:

Windows
MacOS
Linux
|
./uplink.exe share sj://cakes/cheesecake.jpg --export-to cheesecake.access


The --export-to flag is used to export the access to a file. This gives the following output:

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Disallowed
Lists     : Allowed
Deletes   : Disallowed
NotBefore : No restriction
NotAfter  : No restriction
Paths     : sj://cakes/cheesecake.jpg
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 12yUGNqdsKX1Xky2qVoGwdpL...
Exported to: cheesecake.access


Restrict an access

The command uplink access restrict allows you to create a restricted access grant using Create an Access to an Object.

An access generated using uplink access restrict with no arguments creates an access to your entire project with read permissions!

Example:

Windows
MacOS
Linux
|
uplink share --readonly=false --not-before=+2h --not-after=+10h sj://cakes/

Terminal
|
17UjiCXa...


See the access restrict command reference for more actions.

Restrictions

The --readonly flag prevents all write operations (delete and write). Similarly, the --writeonly flag prevents all read operations (read and list).

By default, the access is read-only. To give full permissions, use --readonly=false

You may also indicate the duration of access by specifying a start and end time.

The list of all restrictions can be found share. Example:

Windows
MacOS
Linux
|
uplink share --readonly=false --not-before=+2h --not-after=+10h sj://cakes/

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Allowed
Lists     : Allowed
Deletes   : Allowed
NotBefore : 2021-04-17 17:22:39
NotAfter  : 2021-04-18 01:22:39
Paths     : sj://cakes/ (entire bucket)
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 123qSBBgSUSqwUdbJ6n4bxLM...


See the access restrict and share commands reference for more actions.



Updated 03 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
Prerequisites
NEXT
Import an Access to an Object
Docs powered by archbee 
TABLE OF CONTENTS
Share an object
Restrict an access
Restrictions