Remote Server Credentials

A RemoteServerCredential is a way to store a credential for Remote Servers in a centralized vault and then reference it from Remote Server definitions.

This allows you to manage your credentials in one place and avoid duplicating them across multiple Remote Server configurations. It also enhances security by allowing you to use Terraform or APIs for Remote Server management without having to worry about credential exposure.

List Remote Server Credentials

Command

files-cli remote-server-credentials list

Output

Outputs a list of RemoteServerCredential objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

files-cli remote-server-credentials list

Show Remote Server Credential

Command

files-cli remote-server-credentials find

Output

Outputs a RemoteServerCredential object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Description
--id= int64 Required	Remote Server Credential ID.

Example Request

files-cli remote-server-credentials find \
  --id=1

Create Remote Server Credential

Command

files-cli remote-server-credentials create

Output

Outputs a RemoteServerCredential object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Default	Description
--name= string		Internal name for your reference
--description= string		Internal description for your reference
--server-type= string		Remote server type. Remote Server Credentials are only valid for a single type of Remote Server. Possible values: `ftp`, `sftp`, `s3`, `google_cloud_storage`, `webdav`, `wasabi`, `backblaze_b2`, `one_drive`, `box`, `dropbox`, `google_drive`, `azure`, `sharepoint`, `s3_compatible`, `azure_files`, `files_agent`, `filebase`, `cloudflare`, `linode`, `files_com`
--aws-access-key= string		AWS Access Key.
--s3-assume-role-arn= string		AWS IAM Role ARN for AssumeRole authentication.
--s3-assume-role-duration-seconds= int64		Session duration in seconds for AssumeRole authentication (900-43200).
--cloudflare-access-key= string		Cloudflare: Access Key.
--filebase-access-key= string		Filebase: Access Key.
--google-cloud-storage-s3-compatible-access-key= string		Google Cloud Storage: S3-compatible Access Key.
--linode-access-key= string		Linode: Access Key
--s3-compatible-access-key= string		S3-compatible: Access Key
--sharepoint-client-id= string		SharePoint: Microsoft Entra application client ID for app-only authentication.
--sharepoint-tenant-id= string		SharePoint: Microsoft Entra tenant ID for app-only authentication.
--username= string		Remote server username.
--wasabi-access-key= string		Wasabi: Access Key.
--password= string		Password, if needed.
--private-key= string		Private key, if needed.
--private-key-passphrase= string		Passphrase for private key if needed.
--aws-secret-key= string		AWS: secret key.
--azure-blob-storage-access-key= string		Azure Blob Storage: Access Key
--azure-blob-storage-sas-token= string		Azure Blob Storage: Shared Access Signature (SAS) token
--azure-files-storage-access-key= string		Azure File Storage: Access Key
--azure-files-storage-sas-token= string		Azure File Storage: Shared Access Signature (SAS) token
--backblaze-b2-application-key= string		Backblaze B2 Cloud Storage: applicationKey
--backblaze-b2-key-id= string		Backblaze B2 Cloud Storage: keyID
--cloudflare-secret-key= string		Cloudflare: Secret Key
--filebase-secret-key= string		Filebase: Secret Key
--google-cloud-storage-credentials-json= string		Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
--google-cloud-storage-s3-compatible-secret-key= string		Google Cloud Storage: S3-compatible secret key
--linode-secret-key= string		Linode: Secret Key
--s3-compatible-secret-key= string		S3-compatible: Secret Key
--sharepoint-client-certificate= string		SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
--sharepoint-client-secret= string		SharePoint: Microsoft Entra application client secret for app-only authentication.
--wasabi-secret-key= string		Wasabi: Secret Key
--workspace-id= int64	`0`	Workspace ID (0 for default workspace)
--copy-values-from-credential-id= int64		ID of Remote Server Credential to copy omitted values from.

Example Request

files-cli remote-server-credentials create \
  --name="My Credential"

Update Remote Server Credential

Command

files-cli remote-server-credentials update

Output

Outputs a RemoteServerCredential object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Description
--id= int64 Required	Remote Server Credential ID.
--name= string	Internal name for your reference
--description= string	Internal description for your reference
--server-type= string	Remote server type. Remote Server Credentials are only valid for a single type of Remote Server. Possible values: `ftp`, `sftp`, `s3`, `google_cloud_storage`, `webdav`, `wasabi`, `backblaze_b2`, `one_drive`, `box`, `dropbox`, `google_drive`, `azure`, `sharepoint`, `s3_compatible`, `azure_files`, `files_agent`, `filebase`, `cloudflare`, `linode`, `files_com`
--aws-access-key= string	AWS Access Key.
--s3-assume-role-arn= string	AWS IAM Role ARN for AssumeRole authentication.
--s3-assume-role-duration-seconds= int64	Session duration in seconds for AssumeRole authentication (900-43200).
--cloudflare-access-key= string	Cloudflare: Access Key.
--filebase-access-key= string	Filebase: Access Key.
--google-cloud-storage-s3-compatible-access-key= string	Google Cloud Storage: S3-compatible Access Key.
--linode-access-key= string	Linode: Access Key
--s3-compatible-access-key= string	S3-compatible: Access Key
--sharepoint-client-id= string	SharePoint: Microsoft Entra application client ID for app-only authentication.
--sharepoint-tenant-id= string	SharePoint: Microsoft Entra tenant ID for app-only authentication.
--username= string	Remote server username.
--wasabi-access-key= string	Wasabi: Access Key.
--password= string	Password, if needed.
--private-key= string	Private key, if needed.
--private-key-passphrase= string	Passphrase for private key if needed.
--aws-secret-key= string	AWS: secret key.
--azure-blob-storage-access-key= string	Azure Blob Storage: Access Key
--azure-blob-storage-sas-token= string	Azure Blob Storage: Shared Access Signature (SAS) token
--azure-files-storage-access-key= string	Azure File Storage: Access Key
--azure-files-storage-sas-token= string	Azure File Storage: Shared Access Signature (SAS) token
--backblaze-b2-application-key= string	Backblaze B2 Cloud Storage: applicationKey
--backblaze-b2-key-id= string	Backblaze B2 Cloud Storage: keyID
--cloudflare-secret-key= string	Cloudflare: Secret Key
--filebase-secret-key= string	Filebase: Secret Key
--google-cloud-storage-credentials-json= string	Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
--google-cloud-storage-s3-compatible-secret-key= string	Google Cloud Storage: S3-compatible secret key
--linode-secret-key= string	Linode: Secret Key
--s3-compatible-secret-key= string	S3-compatible: Secret Key
--sharepoint-client-certificate= string	SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
--sharepoint-client-secret= string	SharePoint: Microsoft Entra application client secret for app-only authentication.
--wasabi-secret-key= string	Wasabi: Secret Key

Example Request

files-cli remote-server-credentials update \
  --id=1 \
  --name="My Credential"

Delete Remote Server Credential

Command

files-cli remote-server-credentials delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Description
--id= int64 Required	Remote Server Credential ID.

Example Request

files-cli remote-server-credentials delete \
  --id=1

The RemoteServerCredential Object

Some of the commands above return a RemoteServerCredential object. The attributes of this object are listed below.

Attribute	Description
id int64	Remote Server Credential ID
workspace_id int64	Workspace ID (0 for default workspace)
name string	Internal name for your reference
description string	Internal description for your reference
server_type string	Remote server type. Remote Server Credentials are only valid for a single type of Remote Server. Possible values: `ftp`, `sftp`, `s3`, `google_cloud_storage`, `webdav`, `wasabi`, `backblaze_b2`, `one_drive`, `box`, `dropbox`, `google_drive`, `azure`, `sharepoint`, `s3_compatible`, `azure_files`, `files_agent`, `filebase`, `cloudflare`, `linode`, `files_com`
aws_access_key string	AWS Access Key.
s3_assume_role_arn string	AWS IAM Role ARN for AssumeRole authentication.
s3_assume_role_duration_seconds int64	Session duration in seconds for AssumeRole authentication (900-43200).
s3_assume_role_external_id string	External ID for AssumeRole authentication.
google_cloud_storage_s3_compatible_access_key string	Google Cloud Storage: S3-compatible Access Key.
wasabi_access_key string	Wasabi: Access Key.
s3_compatible_access_key string	S3-compatible: Access Key
filebase_access_key string	Filebase: Access Key.
cloudflare_access_key string	Cloudflare: Access Key.
linode_access_key string	Linode: Access Key
sharepoint_tenant_id string	SharePoint: Microsoft Entra tenant ID for app-only authentication.
sharepoint_client_id string	SharePoint: Microsoft Entra application client ID for app-only authentication.
sharepoint_app_credential_type string	SharePoint: App-only credential type. Either secret or certificate.
username string	Remote server username.

Remote Server Credentials

List Remote Server Credentials

Command

Output

Authorization Requirement

Additional Arguments

Pagination

Sorting

Filtering

Show Remote Server Credential

Command

Output

Authorization Requirement

Flags

Create Remote Server Credential

Command

Output

Authorization Requirement

Flags

Update Remote Server Credential

Command

Output

Authorization Requirement

Flags

Delete Remote Server Credential

Command

Output

Authorization Requirement

Flags

The RemoteServerCredential Object