CLclaimmind
Settings

Create Sftp Config

Create SFTP configuration.

post/admin/settings/sftp

Request

  • Base URL
    https://developer.claimmind.life (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: token

Query parameters

tenant_idstring nullable

Tenant ID

Request body

sftp_hostnamestring required
sftp_portinteger
sftp_usernamestring required
sftp_passwordstring required
sftp_base_pathstring
sftp_batch_sizeinteger

Example request

{
  "sftp_base_path": "/claims/inbox",
  "sftp_batch_size": 10,
  "sftp_hostname": "sftp.hospital.example.com",
  "sftp_password": "secure_password_123",
  "sftp_port": 22,
  "sftp_username": "claimmind_user"
}

Response

Successful Response

sftp_hostnamestring nullable
sftp_portinteger nullable
sftp_usernamestring nullable
sftp_base_pathstring nullable
sftp_batch_sizeinteger nullable
is_configuredboolean

Example response

{
  "is_configured": true,
  "sftp_base_path": "/claims/inbox",
  "sftp_batch_size": 10,
  "sftp_hostname": "sftp.hospital.example.com",
  "sftp_port": 22,
  "sftp_username": "claimmind_user"
}

Changes

No recorded changes to this operation across all 1 revision of this API.