FIfiles
remote_server_credentials
Remote Server Credentials

Update Remote Server Credential

Changed on

Update Remote Server Credential

patch/remote_server_credentials/{id}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/remote_server_credentials/{id}
  • Auth
    none declared

Path parameters

idinteger required

Remote Server Credential ID.

Request body multipart/form-data

namestring

Internal name for your reference

descriptionstring

Internal description for your reference

server_type'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'

Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.

aws_access_keystring

AWS Access Key.

s3_assume_role_arnstring

AWS IAM Role ARN for AssumeRole authentication.

s3_assume_role_duration_secondsinteger

Session duration in seconds for AssumeRole authentication (900-43200).

cloudflare_access_keystring

Cloudflare: Access Key.

filebase_access_keystring

Filebase: Access Key.

google_cloud_storage_s3_compatible_access_keystring

Google Cloud Storage: S3-compatible Access Key.

linode_access_keystring

Linode: Access Key

s3_compatible_access_keystring

S3-compatible: Access Key

sharepoint_client_idstring

SharePoint: Microsoft Entra application client ID for app-only authentication.

sharepoint_tenant_idstring

SharePoint: Microsoft Entra tenant ID for app-only authentication.

usernamestring

Remote server username.

wasabi_access_keystring

Wasabi: Access Key.

passwordstring

Password, if needed.

private_keystring

Private key, if needed.

private_key_passphrasestring

Passphrase for private key if needed.

aws_secret_keystring

AWS: secret key.

azure_blob_storage_access_keystring

Azure Blob Storage: Access Key

azure_blob_storage_sas_tokenstring

Azure Blob Storage: Shared Access Signature (SAS) token

azure_files_storage_access_keystring

Azure File Storage: Access Key

azure_files_storage_sas_tokenstring

Azure File Storage: Shared Access Signature (SAS) token

backblaze_b2_application_keystring

Backblaze B2 Cloud Storage: applicationKey

backblaze_b2_key_idstring

Backblaze B2 Cloud Storage: keyID

cloudflare_secret_keystring

Cloudflare: Secret Key

filebase_secret_keystring

Filebase: Secret Key

google_cloud_storage_credentials_jsonstring

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_keystring

Google Cloud Storage: S3-compatible secret key

linode_secret_keystring

Linode: Secret Key

s3_compatible_secret_keystring

S3-compatible: Secret Key

sharepoint_client_certificatestring

SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.

sharepoint_client_secretstring

SharePoint: Microsoft Entra application client secret for app-only authentication.

wasabi_secret_keystring

Wasabi: Secret Key

Example request

{
  "name": "My Credential",
  "description": "More information or notes about this credential.",
  "server_type": "s3",
  "aws_access_key": "example",
  "s3_assume_role_arn": "example",
  "s3_assume_role_duration_seconds": 1,
  "cloudflare_access_key": "example",
  "filebase_access_key": "example",
  "google_cloud_storage_s3_compatible_access_key": "example",
  "linode_access_key": "example",
  "s3_compatible_access_key": "example",
  "sharepoint_client_id": "00000000-0000-0000-0000-000000000000",
  "sharepoint_tenant_id": "00000000-0000-0000-0000-000000000000",
  "username": "user",
  "wasabi_access_key": "example"
}

Response

The RemoteServerCredentials object.

idinteger

Remote Server Credential ID

workspace_idinteger

Workspace ID (0 for default workspace)

namestring

Internal name for your reference

descriptionstring

Internal description for your reference

server_type'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'

Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.

aws_access_keystring

AWS Access Key.

s3_assume_role_arnstring

AWS IAM Role ARN for AssumeRole authentication.

s3_assume_role_duration_secondsinteger

Session duration in seconds for AssumeRole authentication (900-43200).

s3_assume_role_external_idstring

External ID for AssumeRole authentication.

google_cloud_storage_s3_compatible_access_keystring

Google Cloud Storage: S3-compatible Access Key.

wasabi_access_keystring

Wasabi: Access Key.

s3_compatible_access_keystring

S3-compatible: Access Key

filebase_access_keystring

Filebase: Access Key.

cloudflare_access_keystring

Cloudflare: Access Key.

linode_access_keystring

Linode: Access Key

sharepoint_tenant_idstring

SharePoint: Microsoft Entra tenant ID for app-only authentication.

sharepoint_client_idstring

SharePoint: Microsoft Entra application client ID for app-only authentication.

sharepoint_app_credential_typestring

SharePoint: App-only credential type. Either secret or certificate.

usernamestring

Remote server username.

Example response

{
  "id": 1,
  "name": "My Credential",
  "description": "More information or notes about this credential.",
  "server_type": "s3",
  "aws_access_key": "example",
  "s3_assume_role_arn": "example",
  "s3_assume_role_duration_seconds": 1,
  "s3_assume_role_external_id": "example",
  "google_cloud_storage_s3_compatible_access_key": "example",
  "wasabi_access_key": "example",
  "s3_compatible_access_key": "example",
  "filebase_access_key": "example",
  "cloudflare_access_key": "example",
  "linode_access_key": "example",
  "sharepoint_tenant_id": "00000000-0000-0000-0000-000000000000",
  "sharepoint_client_id": "00000000-0000-0000-0000-000000000000",
  "sharepoint_app_credential_type": "secret",
  "username": "user"
}

Changes