Document AI — Storage Mounts

Test storage mount connection

Test whether a saved storage mount is reachable, or validate connector credentials before saving.

post/storage_mounts/test

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/storage_mounts/test
  • Auth: HTTP bearer

Request body

mount_idstring

ID of an existing storage mount to test (omit when sending dry-run connector credentials in the body).

connector_typestring

Connector type for dry-run test: sftp, ftp, ftps, smb, webdav, or s3.

hoststring

Hostname for dry-run connection test (example: files.example.com).

portstring

Port for dry-run connection test (example: 22 for SFTP).

usernamestring

Username for dry-run connection test.

passwordstring

Password for dry-run connection test — use a placeholder in shared collections.

Response

Success

processing_timestring required

Processing time (format: 123.45ms)

connectedboolean

Connected

messagestring

Status message or error description

latency_msnumber

Latency ms

status'success' | 'error'

Request status: "success" or "error"

Changes