Skip to main content

storageProviders

Paperspace Gradient CLI reference guide for storageProviders.

create s3

Create storage providers

Examples

gradient storageProviders create s3 \
--name "NewStorageProvider" \
--bucket "new-storage-provider" \
--accessKey "AKIAVWO7J5OJ47KDBSIV" \
--secretAccessKey "K8j7Qbh/rofyNRoIZotjlm..."

Options

NameTypeAttributesDescription
--namestringrequiredStorage provider name
--bucketstringrequiredS3 bucket
--accessKeystringrequiredS3 access key ID
--secretAccessKeystringrequiredS3 secret access key
--endpointstringoptionalS3 endpoint URL
--regionstringoptionalS3 region
--signatureVersionstringoptionalS3 signature version
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Created new storage provider with id: splia57f7o5jqke

details

Show storage provider details

Examples

gradient storageProviders details \
--id "splia57f7o5jqke"

Options

NameTypeAttributesDescription
--idstringrequiredStorage provider ID
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

+--------+---------------------------------+
| Name | NewStorageProvider |
+--------+---------------------------------+
| ID | splia57f7o5jqke |
| Type | s3 |
| Config | accessKey: AKIAVWO7J5OJ47KDBSIV |
| | bucket: new-storage-provider |
| | retainData: False |
| | secretAccessKey: ******** |
+--------+---------------------------------+

list

List storage providers

Examples

gradient storageProviders list

Options

NameTypeAttributesDescription
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

+--------------------+-----------------+------+------------------------------------------+
| Name | ID | Type | Config |
+--------------------+-----------------+------+------------------------------------------+
| Gradient Managed | sp65qbxcrsgiv43 | s3 | accessKey: 6P0NXXIKSB49ZW7ZXESL |
| | | | bucket: tewr3st2z |
| | | | endpoint: https://osg-ny2.paperspace.io/ |
| | | | retainData: False |
| | | | secretAccessKey: ******** |
| NewStorageProvider | splia57f7o5jqke | s3 | accessKey: AKIAVWO7J5OJ47KDBSIV |
| | | | bucket: new-storage-provider |
| | | | retainData: False |
| | | | secretAccessKey: ******** |
+--------------------+-----------------+------+------------------------------------------+

update s3

Update s3 storage provider

Examples

gradient storageProviders update s3 \
--id "splia57f7o5jqke" \
--name "NewNameStorageProvider"

Options

NameTypeAttributesDescription
--idstringrequiredStorage provider ID
--namestringoptionalStorage provider name
--bucketstringoptionalS3 bucket
--accessKeystringoptionalS3 access key ID
--secretAccessKeystringoptionalS3 secret access key
--endpointstringoptionalS3 endpoint URL
--regionstringoptionalS3 region
--signatureVersionstringoptionalS3 signature version
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Updated storage provider

delete

Delete storage providers

Examples

gradient storageProviders delete \
--id "splia57f7o5jqke"

Options

NameTypeAttributesDescription
--idstringrequiredStorage provider ID
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Deleted storage provider: splromkivaz8ztg