API docs by Redocly

Reemote (0.1.3)

Download OpenAPI specification:

An API for controlling remote systems.

Inventory Management

Inventory management.

Create Inventory

Create an inventory

Request Body schema: application/json
required
Array of objects (Hosts)

A list of inventory items representing remote hosts.

Responses

Request samples

Content type
application/json
{
  • "hosts": [
    ]
}

Response samples

Content type
application/json
{
  • "error": true,
  • "value": "string"
}

Add Host

Add a new host to the inventory

Request Body schema: application/json
required
required
object (Connection)

The connection details for the remote host.

Authentication (object) or null

The authentication details for the remote host.

Session (object) or null

The session details for the remote host.

groups
Array of strings (Groups)
Default: []

The groups to which the remote host belongs.

Responses

Request samples

Content type
application/json
{
  • "connection": {
    },
  • "authentication": {
    },
  • "session": {
    },
  • "groups": [ ]
}

Response samples

Content type
application/json
{
  • "error": true,
  • "value": "string"
}

Delete Host

Delete a host from the inventory

path Parameters
host
required
string (Host)

The hostname or IP address of the host to delete

Responses

Response samples

Content type
application/json
{
  • "error": true,
  • "value": "string"
}

Get Inventory

Retrieve the inventory

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Host Operations

Get information about the hosts and issue shell commands.

Shell

Execute a shell command on the remote host

query Parameters
cmd
required
string (Cmd)
Examples: cmd=echo Hello World! cmd=ls -ltr

Shell command

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Context

Retrieve the context

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

APT Package Manager

Manage software installed on the hosts.

Get Packages

Get installed APT packages

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Install

Install APT packages

query Parameters
packages
required
Array of strings (Packages)

List of package names

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Remove

Remove APT packages

query Parameters
packages
required
Array of strings (Packages)

List of package names

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Update

Update APT packages

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Upgrade

Upgrade APT packages

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Package

Manage installed APT packages

query Parameters
packages
required
Array of strings (Packages)

List of package names

present
boolean (Present)
Default: true

Whether the packages should be present or not

update
boolean (Update)
Default: false

Whether or not to update the package list

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

sudo
boolean (Sudo)
Default: false

Whether to use sudo

su
boolean (Su)
Default: false

Whether to use su

Request Body schema: application/json
Connection (object) or Connection (null) (Connection)
Default: {}

Optional connection arguments to pass to Asyncssh create_session().

Session (object) or Session (null) (Session)
Default: {}

Optional session arguments to pass to Asyncssh create_session().

Responses

Request samples

Content type
application/json
{
  • "connection": { },
  • "session": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

SCP Operations

Copy files and directories to and from remote hosts.

Upload

Upload files to the host

query Parameters
srcpaths
required
Array of strings (Srcpaths)

The paths of the source files or directories to copy

dstpath
required
string (Dstpath)

The path of the destination file or directory to copy into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

block_size
integer (Block Size) >= 1
Default: 16384

The block size to use for file reads and writes

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download

Download files from the host

query Parameters
srcpaths
required
Array of strings (Srcpaths)

The paths of the source files or directories to copy

dstpath
string (Dstpath)

The path of the destination file or directory to copy into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

block_size
integer (Block Size) >= 1
Default: 16384

The block size to use for file reads and writes

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Copy

Copy files between hosts

query Parameters
srcpaths
required
Array of strings (Srcpaths)

The paths of the source files or directories to copy

dstpath
string (Dstpath)

The path of the destination file or directory to copy into

dsthost
string (Dsthost)

The group of the host to copy to

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

block_size
integer (Block Size) >= 1
Default: 16384

The block size to use for file reads and writes

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SFTP Operations

Create files and directories on remote hosts and transfer files to from hosts.

Isfile

Return if the remote path refers to a file

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Path to check if it's a file

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Isdir

Return if the remote path refers to a directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Path to check if it's a directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getsize

Return the size of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the size of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getatime

Return the last access time of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the last access time of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getatimens

Return the last access time of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the last access time of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getmtime

Return the last modification time of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the last modification time of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getmtimens

Return the last modification time of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the last modification time of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getcrtime

Return the creation time of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the creation time of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getcrtimens

Return the creation time of a remote file or directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Return the creation time of a remote file or directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getcwd

Return the current remote working directory

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stat

Get attributes of a remote file, directory, or symlink

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote file or directory to get attributes for

follow_symlinks
boolean (Follow Symlinks)
Default: true

Whether or not to follow symbolic links

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read

Read a remote file

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The name of the remote file to read

Encoding (string) or Encoding (null) (Encoding)
Default: "utf-8"

The Unicode encoding to use for data read from the remote file

Errors (string) or Errors (null) (Errors)
Default: "strict"

The error-handling mode if an invalid Unicode byte sequence is detected, defaulting to ‘strict’ which raises an exception

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for read requests

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read requests

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listdir

Read the names of the files in a remote directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Read the names of the files in a remote directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Readdir

Read the contents of a remote directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote directory to read

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Exists

Return if the remote path exists and isn’t a broken symbolic link

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The remote path to check

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lexists

Return if the remote path exists, without following symbolic links

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The remote path to check

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lstat

Get attributes of a remote file, directory, or symlink

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote file, directory, or link to get attributes for

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Glob

Match remote files against glob patterns

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Glob patterns to try and match remote files against

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Globsftpname

Match glob patterns and return SFTPNames

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Glob patterns to try and match remote files against

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Statvfs

Get attributes of a remote file system

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote file system to get attributes for

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Realpath

Return the canonical version of a remote path

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote directory to canonicalize

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client

Return sftp client information

query Parameters
Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Copy

Copy remote files to a new location

query Parameters
required
Srcpaths (string) or Srcpaths (string) or Srcpaths (string) or (Array of Srcpaths (strings or strings or strings)) (Srcpaths)

The paths of the remote files or directories to copy

required
Dstpath (string) or Dstpath (string) or Dstpath (string) or Dstpath (null) (Dstpath)

The path of the remote file or directory to copy into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

sparse
boolean (Sparse)
Default: true

Whether or not to do a sparse file copy where it is supported

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for file reads and writes

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Progress Handler (string) or Progress Handler (null) (Progress Handler)

Callback function name for upload progress

Error Handler (string) or Error Handler (null) (Error Handler)

Callback function name for error handling

remote_only
boolean (Remote Only)
Default: false

Whether or not to only allow this to be a remote copy

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mcopy

Copy remote files to a new location

query Parameters
required
Srcpaths (string) or Srcpaths (string) or Srcpaths (string) or (Array of Srcpaths (strings or strings or strings)) (Srcpaths)

The paths of the remote files or directories to copy

required
Dstpath (string) or Dstpath (string) or Dstpath (string) or Dstpath (null) (Dstpath)

The path of the remote file or directory to copy into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

sparse
boolean (Sparse)
Default: true

Whether or not to do a sparse file copy where it is supported

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for file reads and writes

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Progress Handler (string) or Progress Handler (null) (Progress Handler)

Callback function name for upload progress

Error Handler (string) or Error Handler (null) (Error Handler)

Callback function name for error handling

remote_only
boolean (Remote Only)
Default: false

Whether or not to only allow this to be a remote copy

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get

Download remote files

query Parameters
required
Remotepaths (string) or Remotepaths (string) or Remotepaths (string) or (Array of Remotepaths (strings or strings or strings)) (Remotepaths)

The paths of the remote files or directories to download

required
Localpath (string) or Localpath (string) or Localpath (string) (Localpath)

The path of the local file or directory to download into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

sparse
boolean (Sparse)
Default: true

Whether or not to do a sparse file copy where it is supported

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for file reads and writes

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Progress Handler (string) or Progress Handler (null) (Progress Handler)

Callback function name for upload progress

Error Handler (string) or Error Handler (null) (Error Handler)

Callback function name for error handling

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mget

Download remote files with glob pattern match

query Parameters
required
Remotepaths (string) or Remotepaths (string) or Remotepaths (string) or (Array of Remotepaths (strings or strings or strings)) (Remotepaths)

The paths of the remote files or directories to download

required
Localpath (string) or Localpath (string) or Localpath (string) (Localpath)

The path of the local file or directory to download into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

sparse
boolean (Sparse)
Default: true

Whether or not to do a sparse file copy where it is supported

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for file reads and writes

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Progress Handler (string) or Progress Handler (null) (Progress Handler)

Callback function name for upload progress

Error Handler (string) or Error Handler (null) (Error Handler)

Callback function name for error handling

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Put

Upload local files

query Parameters
required
Localpaths (string) or Localpaths (string) or Localpaths (string) or (Array of Localpaths (strings or strings or strings)) (Localpaths)

The paths of the local files or directories to upload

required
Remotepath (string) or Remotepath (string) or Remotepath (string) (Remotepath)

The path of the remote file or directory to upload into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

sparse
boolean (Sparse)
Default: true

Whether or not to do a sparse file copy where it is supported

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for file reads and writes

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Progress Handler (string) or Progress Handler (null) (Progress Handler)

Callback function name for upload progress

Error Handler (string) or Error Handler (null) (Error Handler)

Callback function name for error handling

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mput

Upload local files with glob pattern match

query Parameters
required
Localpaths (string) or Localpaths (string) or Localpaths (string) or (Array of Localpaths (strings or strings or strings)) (Localpaths)

The paths of the local files or directories to upload

required
Remotepath (string) or Remotepath (string) or Remotepath (string) (Remotepath)

The path of the remote file or directory to upload into

preserve
boolean (Preserve)
Default: false

Whether or not to preserve the original file attributes

recurse
boolean (Recurse)
Default: false

Whether or not to recursively copy directories

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

sparse
boolean (Sparse)
Default: true

Whether or not to do a sparse file copy where it is supported

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for file reads and writes

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Progress Handler (string) or Progress Handler (null) (Progress Handler)

Callback function name for upload progress

Error Handler (string) or Error Handler (null) (Error Handler)

Callback function name for error handling

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mkdir

Create a remote directory with the specified attributes

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Directory path

Permissions (integer) or Permissions (null) (Permissions)

Directory permissions as integer

Uid (integer) or Uid (null) (Uid)

User ID

Gid (integer) or Gid (null) (Gid)

Group ID

Atime (integer) or Atime (null) (Atime)

Access time

Mtime (integer) or Mtime (null) (Mtime)

Modification time

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mkdir

Set attributes of a remote file, directory, or symlink

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote file or directory to set attributes for

Permissions (integer) or Permissions (null) (Permissions)

Directory permissions as integer

Uid (integer) or Uid (null) (Uid)

User ID

Gid (integer) or Gid (null) (Gid)

Group ID

Atime (integer) or Atime (null) (Atime)

Access time

Mtime (integer) or Mtime (null) (Mtime)

Modification time

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mkdirs

Create a remote directory with the specified attributes

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Directory path

Permissions (integer) or Permissions (null) (Permissions)

Directory permissions as integer

Uid (integer) or Uid (null) (Uid)

User ID

Gid (integer) or Gid (null) (Gid)

Group ID

Atime (integer) or Atime (null) (Atime)

Access time

Mtime (integer) or Mtime (null) (Mtime)

Modification time

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rmdir

Remove a remote directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote directory to remove

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rmtree

Recursively delete a directory tree

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the parent directory to remove

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Chmod

Change the permissions of a remote file, directory, or symlink

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Directory path

Permissions (integer) or Permissions (null) (Permissions)

Directory permissions as integer

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Chown

Change the owner of a remote file, directory, or symlink

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Directory path

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

Uid (integer) or Uid (null) (Uid)

User ID

Gid (integer) or Gid (null) (Gid)

Group ID

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Utime

Change the timestamps of a remote file, directory, or symlink

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

Directory path

follow_symlinks
boolean (Follow Symlinks)
Default: false

Whether or not to follow symbolic links

Atime (integer) or Atime (null) (Atime)

Access time, as seconds relative to the UNIX epoch

Mtime (integer) or Mtime (null) (Mtime)

Modify time, as seconds relative to the UNIX epoch

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Chdir

Change the current remote working directory

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path to set as the new remote working directory

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rename

Rename a remote file, directory, or link

query Parameters
required
Oldpath (string) or Oldpath (string) or Oldpath (string) (Oldpath)

The path of the remote file, directory, or link to rename

required
Newpath (string) or Newpath (string) or Newpath (string) (Newpath)

The new name for this file, directory, or link

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove

Remove a remote file

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote file or link to remove

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Write

Open a remote file

query Parameters
text
required
string (Text)

The text to write to the remote file

required
Path (string) or Path (string) or Path (string) (Path)

The name of the remote file to open

Mode (integer) or Mode (string) (Mode)
Default: "w"

Mode

Permissions (integer) or Permissions (null) (Permissions)

File permissions as integer

Uid (integer) or Uid (null) (Uid)

User ID

Gid (integer) or Gid (null) (Gid)

Group ID

Atime (integer) or Atime (null) (Atime)

Access time

Mtime (integer) or Mtime (null) (Mtime)

Modification time

Encoding (string) or Encoding (null) (Encoding)
Default: "utf-8"

The Unicode encoding to use for data read and written to the remote file

Errors (string) or Errors (null) (Errors)
Default: "strict"

The error-handling mode if an invalid Unicode byte sequence is detected, defaulting to â strictâ which raises an exception

Block Size (integer) or Block Size (null) (Block Size)
Default: -1

The block size to use for read and write requests

Max Requests (integer) or Max Requests (null) (Max Requests)
Default: -1

The maximum number of parallel read or write requests

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Link

Rename a remote file, directory, or link

query Parameters
required
File Path (string) or File Path (string) or File Path (string) (File Path)

The path of the remote file the hard link should point to

required
Link Path (string) or Link Path (string) or Link Path (string) (Link Path)

The path of where to create the remote hard link

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Symlink

Create a remote symbolic link

query Parameters
required
File Path (string) or File Path (string) or File Path (string) (File Path)

The path the link should point to

required
Link Path (string) or Link Path (string) or Link Path (string) (Link Path)

The path of where to create the remote symbolic link

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove

Remove a remote link

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote link to remove

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Truncate

Truncate a remote file to the specified size

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)

The path of the remote file to be truncated

size
required
integer (Size)

The desired size of the file, in bytes

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Directory

Ensure directory exists

query Parameters
required
Path (string) or Path (string) or Path (string) (Path)
Examples: path=/home/user path=testdata/new_dir

Directory path on the remote host

required
Present (boolean) or Present (null) (Present)

Whether the directory should be present or not

Permissions (integer) or Permissions (null) (Permissions)
Examples: permissions=0o644

Directory permissions as integer

Uid (integer) or Uid (null) (Uid)

User ID, user must exist on the remote host

Gid (integer) or Gid (null) (Gid)

Group ID, user must exist on the remote host

Atime (integer) or Atime (null) (Atime)
Examples: atime=0xDEADCAFE

Access time in seconds since epoch

Mtime (integer) or Mtime (null) (Mtime)
Examples: mtime=0xACAFEDAD

Modification time in seconds since epoch

Group (string) or Group (null) (Group)
Default: "all"

Optional inventory group (defaults to 'all')

Name (string) or Name (null) (Name)

Optional name

Responses

Response samples

Content type
application/json
[
  • {
    }
]