atmoz-sftp

Namespace

atmoz-sftp

Description:

  • Effortlessly manage secure file transfers with our user-friendly SFTP server powered by OpenSSH. Ideal for sharing files securely using SSH, it integrates easily with Docker, ensuring both security and simplicity.

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createAtmozSftpInstance(context, body) → {AtmozSftp}

Description:

  • Create a new SFTP Server instance

Example
import { Context } from '@osaas/client-core';
import { createAtmozSftpInstance } from '@osaas/client-services';

const ctx = new Context();
const body: AtmozSftpConfig = { name: 'myinstance', ... };
const instance = await createAtmozSftpInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body AtmozSftpConfig

Service instance configuration
Returns:
  • Service instance
Type
AtmozSftp

(async, static) getAtmozSftpInstance(context, name) → {AtmozSftp}

Description:

  • Get a SFTP Server instance

Example
import { Context } from '@osaas/client-core';
import { getAtmozSftpInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getAtmozSftpInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the sftp to be retrieved
Returns:
  • Service instance
Type
AtmozSftp

(async, static) removeAtmozSftpInstance(context, name)

Description:

  • Remove a SFTP Server instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the sftp to be removed