Object Storage
This section details Object Storage-related Linode CLI commands.
cancel
Cancel Object Storage on an Account.
Usage
The format accepted by this command.
linode-cli object-storage cancel [-h]
Sample
Examples of how this command might be used.
linode-cli object-storage cancel
clusters-list
Warning
This command is deprecated and may not be supported in the future.
Returns a paginated list of available Object Storage legacy clusters.
Usage
The format accepted by this command.
linode-cli object-storage clusters-list [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli object-storage clusters-list
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
domain |
str |
us-east-1.lin…eobjects.com |
The base URL for this cluster, used for connecting with third-party clients. |
id |
str |
us-east-1 |
The unique ID for this cluster. |
region |
str |
us-east |
The region where this cluster is located. |
static_site_domain |
str |
website-us-ea…eobjects.com |
The base URL for this cluster used when hosting static sites. |
status |
str |
available |
This cluster’s status. |
clusters-view
Warning
This command is deprecated and may not be supported in the future.
Returns a single Object Storage cluster.
Usage
The format accepted by this command.
linode-cli object-storage clusters-view [-h] [--order-by {}]
[--order {asc,desc}] clusterId
Sample
Examples of how this command might be used.
linode-cli object-storage clusters-view us-east-1
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
clusterId |
str |
Identifies a cluster where this bucket lives. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
domain |
str |
us-east-1.lin…eobjects.com |
The base URL for this cluster, used for connecting with third-party clients. |
id |
str |
us-east-1 |
The unique ID for this cluster. |
region |
str |
us-east |
The region where this cluster is located. |
static_site_domain |
str |
website-us-ea…eobjects.com |
The base URL for this cluster used when hosting static sites. |
status |
str |
available |
This cluster’s status. |
keys-list
Returns a paginated list of Object Storage keys for authenticating to the Object Storage S3 API.
Usage
The format accepted by this command.
linode-cli object-storage keys-list [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli object-storage keys-list
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
access_key |
str |
KVAKUTGBA4WTR2NSJQ81 |
A unique string chosen by the API to identify this key. |
id |
int |
123 |
This Object Storage key’s unique ID. |
label |
str |
my-key |
The label given to this key. |
limited |
bool |
true |
Whether this Object Storage key limits access to specific buckets and permissions. |
secret_key |
str |
N/A |
This Object Storage key’s secret key. |
bucket_access
Name |
Type |
Example |
Description |
|---|---|---|---|
bucket_access.bucket_name |
str |
example-bucket |
The name of the bucket the key can access in the |
bucket_access.cluster |
str |
us-west-1 |
Identifies the legacy cluster where this key can be used. |
bucket_access.permissions |
str |
read_only |
The level of access the key grants to the |
bucket_access.region |
str |
us-west |
The region where the Object Store |
regions
Name |
Type |
Example |
Description |
|---|---|---|---|
regions.id |
str |
us-west |
Identifies each region where you can use the Object Storage key. |
regions.s3_endpoint |
str |
us-west-00.l…eobjects.com |
The S3-compatible hostname you can use to access the Object Storage buckets in this region. |
keys-view
Returns a single Object Storage key provisioned for your account.
Usage
The format accepted by this command.
linode-cli object-storage keys-view [-h] [--order-by {}]
[--order {asc,desc}] keyId
Sample
Examples of how this command might be used.
linode-cli object-storage keys-view \
--keyId 12345
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
keyId |
int |
The key to look up. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
access_key |
str |
KVAKUTGBA4WTR2NSJQ81 |
A unique string chosen by the API to identify this key. |
id |
int |
123 |
This Object Storage key’s unique ID. |
label |
str |
my-key |
The label given to this key. |
limited |
bool |
true |
Whether this Object Storage key limits access to specific buckets and permissions. |
secret_key |
str |
N/A |
This Object Storage key’s secret key. |
bucket_access
Name |
Type |
Example |
Description |
|---|---|---|---|
bucket_access.bucket_name |
str |
example-bucket |
The name of the bucket the key can access in the |
bucket_access.cluster |
str |
us-west-1 |
Identifies the legacy cluster where this key can be used. |
bucket_access.permissions |
str |
read_only |
The level of access the key grants to the |
bucket_access.region |
str |
us-west |
The region where the Object Store |
regions
Name |
Type |
Example |
Description |
|---|---|---|---|
regions.id |
str |
us-west |
Identifies each region where you can use the Object Storage key. |
regions.s3_endpoint |
str |
us-west-00.l…eobjects.com |
The S3-compatible hostname you can use to access the Object Storage buckets in this region. |
keys-create
Provisions a new Object Storage key for authenticating to the Object Storage S3 API.
Usage
The format accepted by this command.
linode-cli object-storage keys-create [-h] [--regions regions]
[--bucket_access bucket_access]
[--bucket_access.region region]
[--bucket_access.bucket_name bucket_name]
[--bucket_access.permissions permissions] [--label label]
Sample
Examples of how this command might be used.
linode-cli object-storage keys-create \
--label "my-object-storage-key" \
--bucket_access '[{"region": "ap-south", "bucket_name": "bucket-example-1", "permissions": "read_write" }]'
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--bucket_access (section) |
json |
N/A |
N/A |
--label |
str |
my-key |
The label for the Object Storage key, for display purposes only. |
--regions |
[]str |
us-iad |
You can use a key to create new buckets in regions set in this array. |
bucket_access
Name |
Type |
Example |
Description |
|---|---|---|---|
--bucket_access.bucket_name |
str |
example-bucket |
The |
--bucket_access.permissions |
str |
read_write |
The level of access the key grants to the specified |
--bucket_access.region |
str |
us-iad |
The region where the |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
access_key |
str |
KVAKUTGBA4WTR2NSJQ81 |
A unique string chosen by the API to identify this key. |
id |
int |
123 |
This Object Storage key’s unique ID. |
label |
str |
my-key |
The label given to this key. |
limited |
bool |
true |
Whether this Object Storage key limits access to specific buckets and permissions. |
secret_key |
str |
N/A |
This Object Storage key’s secret key. |
bucket_access
Name |
Type |
Example |
Description |
|---|---|---|---|
bucket_access.bucket_name |
str |
example-bucket |
The name of the bucket the key can access in the |
bucket_access.cluster |
str |
us-west-1 |
Identifies the legacy cluster where this key can be used. |
bucket_access.permissions |
str |
read_only |
The level of access the key grants to the |
bucket_access.region |
str |
us-west |
The region where the Object Store |
regions
Name |
Type |
Example |
Description |
|---|---|---|---|
regions.id |
str |
us-west |
Identifies each region where you can use the Object Storage key. |
regions.s3_endpoint |
str |
us-west-00.l…eobjects.com |
The S3-compatible hostname you can use to access the Object Storage buckets in this region. |
keys-update
Updates an Object Storage key on your account.
Usage
The format accepted by this command.
linode-cli object-storage keys-update [-h] [--regions regions]
[--label label] keyId
Sample
Examples of how this command might be used.
linode-cli object-storage keys-update \
--keyId 12345
--label "my-object-storage-key"
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
keyId |
int |
The key to look up. |
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--label |
str |
my-key |
The label for the Object Storage key. |
--regions |
[]str |
us-iad |
Replace the current list of |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
access_key |
str |
KVAKUTGBA4WTR2NSJQ81 |
A unique string chosen by the API to identify this key. |
id |
int |
123 |
This Object Storage key’s unique numeric identifier. |
label |
str |
my-key |
The label given to this key. |
limited |
bool |
true |
Whether this Object Storage key limits access to specific buckets and permissions. |
secret_key |
str |
OiA6F5r0niLs…7KqOzcmitmHw |
This Object Storage key’s secret key. |
regions
Name |
Type |
Example |
Description |
|---|---|---|---|
regions.id |
str |
us-west |
Identifies each region where you can use the Object Storage key. |
regions.s3_endpoint |
str |
us-west-00.l…eobjects.com |
The S3-compatible hostname you can use to access your Object Storage buckets in this region. |
keys-delete
Revokes an Object Storage Key.
Usage
The format accepted by this command.
linode-cli object-storage keys-delete [-h] keyId
Sample
Examples of how this command might be used.
linode-cli object-storage keys-delete 12345
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
keyId |
int |
The key to look up. |
ssl-view
Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.
Usage
The format accepted by this command.
linode-cli object-storage ssl-view [-h] [--order-by {}]
[--order {asc,desc}] regionId bucket
Sample
Examples of how this command might be used.
linode-cli object-storage ssl-view \
us-east-1 example-bucket
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
regionId |
str |
Identifies a region where this bucket lives. |
bucket |
str |
The bucket name. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
ssl |
bool |
true |
A boolean indicating if this Bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user. |
ssl-delete
Deletes this Object Storage bucket’s user uploaded TLS/SSL certificate and private key.
Usage
The format accepted by this command.
linode-cli object-storage ssl-delete [-h] regionId bucket
Sample
Examples of how this command might be used.
linode-cli object-storage ssl-delete \
us-east-1 example-bucket
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
regionId |
str |
Identifies a region where this bucket lives. |
bucket |
str |
The bucket name. |
ssl-upload
Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS.
Usage
The format accepted by this command.
linode-cli object-storage ssl-upload [-h]
[--private_key private_key] [--certificate certificate]
regionId bucket
Sample
Examples of how this command might be used.
linode-cli object-storage ssl-upload \
us-east-1 example-bucket \
--certificate "-----BEGIN CERTIFICATE-----
CERTIFICATE_INFORMATION
-----END CERTIFICATE-----" \
--private_key "-----BEGIN PRIVATE KEY-----
PRIVATE_KEY_INFORMATION
-----END PRIVATE KEY-----"
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
regionId |
str |
Identifies a region where this bucket lives. |
bucket |
str |
The bucket name. |
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--certificate * |
str |
—–BEGIN CE…IFICATE—– |
Your Base64 encoded and PEM formatted SSL certificate. |
--private_key * |
str |
—–BEGIN PR…ATE KEY—– |
The private key associated with this TLS/SSL certificate. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
ssl |
bool |
true |
A boolean indicating if this Bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user. |