APM CLI — Command Reference

Command-line interface for Synology ActiveProtect Manager (APM).

Installation

Requires Python 3.11 or later — provisioned automatically if you use uv/uvx below, otherwise required on your own interpreter for pip install.

Run directly without installing, via uv's uvx launcher:

uvx synology-apm-cli --help

Or install with pip:

pip install synology-apm-cli

Authentication

Every command needs a host (hostname or IP, e.g. apm.corp.com or apm.corp.com:10443), username, and password. https:// is always used — do not include the scheme. There are three ways to supply connection settings, applied in this priority order (highest first):

Config file — recommended

Run once, then forget:

synology-apm-cli config set --host apm.corp.com --username admin

For self-signed certificates (lab / dev), answer y when the wizard asks Skip SSL verification? — or set APM_NO_VERIFY_SSL=true / pass the global --no-verify-ssl flag per invocation.

By default the password is not stored — you will be prompted each time you run a command (or supply it via APM_PASSWORD). To store it, add --save-password plaintext (config file) or --save-password keyring (OS credential store — macOS Keychain / Windows Credential Manager / Linux Secret Service):

synology-apm-cli config set --host apm.corp.com --username admin --save-password plaintext
synology-apm-cli config set --host apm.corp.com --username admin --save-password keyring

Warning: --save-password plaintext saves the password in plain text in ~/.config/synology-apm/config.toml. Only use it on a trusted machine; prefer --save-password keyring or the APM_PASSWORD environment variable on shared/server machines.

Multiple profiles are supported:

synology-apm-cli config set --host apm.corp.com --username admin --profile lab
synology-apm-cli config set --host apm2.corp.com --username dr-admin --profile dr

View or clear config:

synology-apm-cli config show                  # show default profile + list all profiles
synology-apm-cli config show --profile lab    # show specific profile
synology-apm-cli config clear                 # clear default profile
synology-apm-cli config clear --profile lab   # clear specific profile
synology-apm-cli config clear --all           # clear all profiles

Config is stored in ~/.config/synology-apm/config.toml.

Environment variables

export APM_HOST=apm.corp.com
export APM_USERNAME=admin
export APM_PASSWORD=yourpassword   # optional — avoids the interactive prompt
export APM_NO_VERIFY_SSL=true
export APM_PROFILE=lab             # selects a config file profile

Global flags (before the subcommand)

synology-apm-cli --host apm.corp.com \
    --username admin \
    --password yourpassword \
    --no-verify-ssl \
    machine list

Use --no-input to disable all interactive prompts (suitable for scripts and CI). If a required value such as the password is missing, the command exits immediately with code 1 instead of hanging:

APM_HOST=apm.corp.com APM_USERNAME=admin APM_PASSWORD=secret \
  synology-apm-cli --no-input machine list -o json

Flags override environment variables, which override the config file.

Output formats

List, get, and info commands support --output / -o (action commands such as backup, cancel, and config set have no output option):

Value	Description	Availability
`table`	Default — human-readable Rich table	All commands
`json`	JSON — curated fields (nested structure), suitable for piping to `jq`	All commands
`yaml`	YAML format	All commands
`csv`	Flat CSV — table-aligned columns, raw values (bytes as int, datetime as local-timezone ISO 8601)	`list` commands only

synology-apm-cli machine list -o json | jq '.[].name'
synology-apm-cli infra server list -o yaml
synology-apm-cli machine list -o csv > machines.csv
synology-apm-cli activity backup list --since 24h -o csv

Debugging

Use --debug (before the subcommand) to print every API request and response to stderr. Useful when diagnosing unexpected errors or exploring the raw API.

synology-apm-cli --debug machine list

Output goes to stderr so it does not interfere with --output json pipelines:

synology-apm-cli --debug machine list -o json 2>debug.log | jq '.[].name'

Commands

`synology-apm-cli machine`

Manages device backup workloads: PC, Physical Server, VM, and File Server.

`synology-apm-cli machine list`

# List all machine workloads (no --type = all types)
synology-apm-cli machine list

# Filter by type (values: pc / ps / vm / fs; --type is repeatable)
synology-apm-cli machine list --type vm                    # Virtual Machines only
synology-apm-cli machine list --type vm --type fs          # VMs and File Servers

# Additional filters (default shows protected workloads only)
synology-apm-cli machine list --retired                    # only retired workloads
synology-apm-cli machine list --search "prod"              # name keyword search
synology-apm-cli machine list --type vm --retired          # combine type + retired filter
synology-apm-cli machine list --verbose                    # add IP Address / Workload ID / Namespace columns

# Filter by backup status / verification status (both repeatable)
synology-apm-cli machine list --status failed --status partial
synology-apm-cli machine list --verify-status not_enabled   # PS/VM only

`synology-apm-cli machine get`

Two modes (mutually exclusive):

Search mode — find by name (keyword search, default: protected workloads only)
Direct mode — exact lookup, requires both --id and --namespace

# Search by name
synology-apm-cli machine get "CORP-PC-001"
synology-apm-cli machine get "old" --retired        # only among retired workloads
synology-apm-cli machine get "CORP-PC-001" -o json

# Direct lookup
synology-apm-cli machine get --id <workload-id> --namespace <namespace>
synology-apm-cli machine get --id <workload-id> --namespace <namespace> -o json

`synology-apm-cli machine backup`

Two modes (mutually exclusive):

# Search mode — find by name, then backup
synology-apm-cli machine backup "CORP-PC-001"
synology-apm-cli machine backup "CORP-PC-001" --quiet    # no output (scripts)

# Direct mode — exact lookup by ID + namespace
synology-apm-cli machine backup --id <workload-id> --namespace <namespace>

`synology-apm-cli machine cancel`

Two modes (mutually exclusive):

# Search mode (requires confirmation)
synology-apm-cli machine cancel "CORP-PC-001"
synology-apm-cli machine cancel "CORP-PC-001" --yes          # skip confirmation
synology-apm-cli machine cancel "CORP-PC-001" --yes --quiet  # skip confirmation + no output

# Direct mode
synology-apm-cli machine cancel --id <workload-id> --namespace <namespace>
synology-apm-cli machine cancel --id <workload-id> --namespace <namespace> --yes

`synology-apm-cli machine retire`

Two modes (mutually exclusive). --plan is required — get the ID from synology-apm-cli plan retirement list --verbose.

# Search mode (irreversible — requires confirmation)
synology-apm-cli machine retire "CORP-PC-001" --plan <retirement-plan-id>
synology-apm-cli machine retire "CORP-PC-001" --plan <retirement-plan-id> --yes
synology-apm-cli machine retire "CORP-PC-001" --plan <retirement-plan-id> --yes --quiet  # no output

# Direct mode
synology-apm-cli machine retire --id <workload-id> --namespace <namespace> --plan <retirement-plan-id>
synology-apm-cli machine retire --id <workload-id> --namespace <namespace> --plan <retirement-plan-id> --yes

`synology-apm-cli machine change-plan`

Two modes (mutually exclusive). --plan accepts a plan name or UUID. The plan type it is resolved against is auto-detected from the workload's current state: a Protection Plan for an active Workload, a Retirement Plan for an already-retired one (add --retired in search mode to look up a retired Workload by name).

# Change the Protection Plan of an active Workload (search mode)
synology-apm-cli machine change-plan "CORP-PC-001" --plan "Daily Backup"

# Re-assign the Retirement Plan of an already-retired Workload
synology-apm-cli machine change-plan "old-laptop" --retired --plan "Compliance Retention"

# Direct mode
synology-apm-cli machine change-plan --id <workload-id> --namespace <namespace> --plan <plan-id> --yes

`synology-apm-cli machine version list`

Lists backup versions. Table columns: #, Created, Status, Locked, Verification (PS/VM only), Changed Size, Copy Status, Locations, Version ID. Footer shows pagination info (e.g. Showing 1 of 42). Use --verbose to show Workload ID + Namespace in the header. Default search mode finds protected workloads; use --retired for retired workloads.

# Search mode
synology-apm-cli machine version list "CORP-PC-001"
synology-apm-cli machine version list "CORP-PC-001" --limit 25 --offset 25   # page 2
synology-apm-cli machine version list "CORP-PC-001" --since 7d       # 30m | 1h | 24h | 7d | ISO 8601
synology-apm-cli machine version list "CORP-PC-001" --since 2026-04-01T00:00:00
synology-apm-cli machine version list "CORP-PC-001" --until 2026-04-20T23:59:59
synology-apm-cli machine version list "old-laptop" --retired

# Direct mode
synology-apm-cli machine version list --id <workload-id> --namespace <namespace>
synology-apm-cli machine version list --id <workload-id> --namespace <namespace> --since 7d

`synology-apm-cli machine version get`

Shows version info (Version ID, Workload ID, Namespace, storage Locations) followed by activity detail (status, timing, Data Change / Transferred / Actual Capacity Used metrics, logs). M365 activities additionally show Processed items: N succeeded, N warning, N error. --id is the Version ID (from version list); omit to get the latest version automatically. Default search mode finds protected workloads; use --retired for retired workloads.

# Search mode (omit --id to get the latest version)
synology-apm-cli machine version get "CORP-PC-001"
synology-apm-cli machine version get "CORP-PC-001" --id <version-id>
synology-apm-cli machine version get "old-laptop" --id <version-id> --retired

# Direct mode (skips workload lookup — faster)
synology-apm-cli machine version get --workload-id <workload-id> --namespace <namespace>
synology-apm-cli machine version get --workload-id <workload-id> --namespace <namespace> --id <version-id>

`synology-apm-cli machine version lock` / `unlock`

Locks a backup version to prevent automatic deletion by retention policies. --id (Version ID) is required and comes from version list.

# Search mode
synology-apm-cli machine version lock "CORP-PC-001" --id <version-id>
synology-apm-cli machine version lock "CORP-PC-001" --id <version-id> --quiet  # no output
synology-apm-cli machine version unlock "CORP-PC-001" --id <version-id>

# Direct mode
synology-apm-cli machine version lock --workload-id <workload-id> --namespace <namespace> --id <version-id>
synology-apm-cli machine version unlock --workload-id <workload-id> --namespace <namespace> --id <version-id>

`synology-apm-cli saas`

Lists connected SaaS tenants (Microsoft 365 and Google Workspace).

# List all connected SaaS tenants (M365 + GWS)
# Output includes: Category, Name, Email/Domain, Protected Size, Tenant ID
synology-apm-cli saas list

`synology-apm-cli m365`

Manages Microsoft 365 backup workloads grouped by service type.

The --tenant-id / -t option selects the M365 tenant. For list, and for get/backup/cancel/retire in search mode, it is optional — if omitted, the first M365 tenant from synology-apm-cli saas list is used automatically. For direct mode (--id + --namespace), it is not needed.

The examples below use exchange; every other service type has the identical interface (substitute the scope name).

TENANT="123e4567-e89b-12d3-a456-426614174005"

# List M365 workloads by service type
# In table mode, tenant name and domain are displayed above the workload table.
synology-apm-cli m365 exchange   list                       # auto-resolve tenant
synology-apm-cli m365 exchange   list -t $TENANT            # scopes: exchange / onedrive / chat / group / sharepoint / teams
synology-apm-cli m365 exchange   list --retired             # only retired workloads (default: protected)
synology-apm-cli m365 exchange   list --search "alice"      # name/email keyword search
synology-apm-cli m365 exchange   list --verbose             # add Workload ID / Namespace columns
synology-apm-cli m365 exchange   list -o json               # JSON output (no tenant header)
synology-apm-cli m365 exchange   list --status failed --status partial  # repeatable

# Inspect a single M365 workload — two modes:
# Search mode (find by name/email/URL — auto-resolves tenant if -t omitted; add --retired
# to search among retired workloads):
synology-apm-cli m365 exchange get "alice@contoso.com"
# Direct mode (requires workload uid + namespace — no --tenant-id needed):
synology-apm-cli m365 exchange get --id <workload-uid> --namespace <ns>

# Trigger / cancel a manual backup (cancel requires confirmation; --yes skips it)
synology-apm-cli m365 exchange backup "alice@contoso.com"
synology-apm-cli m365 exchange cancel "alice@contoso.com"
synology-apm-cli m365 exchange cancel --id <workload-uid> --namespace <ns> --yes

# Retire an M365 workload (irreversible — use synology-apm-cli plan retirement list --verbose to get plan ID)
synology-apm-cli m365 exchange retire "alice@contoso.com" --plan <retirement-plan-id>

# Change the plan assigned to an M365 workload (--plan accepts plan name or UUID; the plan type
# it is resolved against is auto-detected from the workload's current state)
synology-apm-cli m365 exchange change-plan "alice@contoso.com" --plan "Daily Backup"
synology-apm-cli m365 exchange change-plan "bob@contoso.com" --retired --plan "Compliance Retention"

# List backup versions (Table columns: #, Created, Status, Locked, Changed Size, Copy Status, Locations, Version ID)
synology-apm-cli m365 exchange version list "alice@contoso.com"
synology-apm-cli m365 exchange version list "alice@contoso.com" --limit 25 --offset 25   # page 2
synology-apm-cli m365 exchange version list --id <workload-uid> --namespace <ns> --since 7d  # direct mode

# Show version info and activity detail (omit --id to get the latest version)
synology-apm-cli m365 exchange version get "alice@contoso.com"
synology-apm-cli m365 exchange version get --workload-id <workload-uid> --namespace <ns> --id <version-id>

# Lock / unlock a version (--id is required)
synology-apm-cli m365 exchange version lock "alice@contoso.com" --id <version-id>
synology-apm-cli m365 exchange version unlock "alice@contoso.com" --id <version-id>

# Export mailbox to PST — list export tasks
synology-apm-cli m365 exchange export list "alice@contoso.com"

# Export mailbox to PST — start export and download (auto-start mode)
# Starts a new export for the latest version and downloads when ready
synology-apm-cli m365 exchange export download "alice@contoso.com"
synology-apm-cli m365 exchange export download "alice@contoso.com" --archive-mailbox      # export archive mailbox instead
synology-apm-cli m365 exchange export download "alice@contoso.com" --version-id <vid>     # specify a backup version
synology-apm-cli m365 exchange export download "alice@contoso.com" --no-wait              # print Activity ID if available, exit immediately
synology-apm-cli m365 exchange export download "alice@contoso.com" --filename mailbox.pst # custom local filename

# Export mailbox to PST — download a previously started export (direct download mode)
synology-apm-cli m365 exchange export download "alice@contoso.com" --id <activity-id>

# Export mailbox to PST — cancel an in-progress export task
synology-apm-cli m365 exchange export cancel "alice@contoso.com" --id <activity-id>

# Group mailbox export: same interface via `m365 group export`, without --archive-mailbox
synology-apm-cli m365 group export download "marketing@contoso.com"

`synology-apm-cli plan`

Manages Protection Plans, Retirement Plans, and Tiering Plans.

`synology-apm-cli plan protection`

Lists and inspects backup protection plans. To apply a plan to a workload, use synology-apm-cli machine change-plan / synology-apm-cli m365 <scope> change-plan.

# List all protection plans (machine and M365 plans together)
synology-apm-cli plan protection list
synology-apm-cli plan protection list --category machine   # Machine plans only
synology-apm-cli plan protection list --category m365      # M365 plans only
synology-apm-cli plan protection list --search "Daily"
synology-apm-cli plan protection list -v               # show Description and Plan ID columns

# Inspect a plan (search by name or direct by ID)
synology-apm-cli plan protection get "Daily Backup"              # search by name (machine + M365)
synology-apm-cli plan protection get --id <plan-id>              # direct by UUID
synology-apm-cli plan protection get --id <plan-id> -o json

`synology-apm-cli plan retirement`

Manages retirement plans used when retiring workloads. To re-assign a retirement plan to an already-retired workload, use synology-apm-cli machine change-plan / synology-apm-cli m365 <scope> change-plan.

# List all retirement plans (-v shows Plan ID)
synology-apm-cli plan retirement list
synology-apm-cli plan retirement list --search "30-Day"
synology-apm-cli plan retirement list -v           # show Plan ID column

# Inspect a retirement plan (search by name or direct by ID)
synology-apm-cli plan retirement get "Compliance Retention"      # search by name
synology-apm-cli plan retirement get --id <plan-id>              # direct by UUID
synology-apm-cli plan retirement get --id <plan-id> -o json

`synology-apm-cli plan tiering`

Lists and inspects tiering plans (version tiering to remote storage).

# List all tiering plans (-v shows Plan ID)
synology-apm-cli plan tiering list
synology-apm-cli plan tiering list --search "30-Day"
synology-apm-cli plan tiering list -v                  # show Plan ID column

# Inspect a tiering plan (search by name or direct by ID)
synology-apm-cli plan tiering get "30-Day Tiering"               # search by name
synology-apm-cli plan tiering get --id <plan-id>                 # direct by UUID
synology-apm-cli plan tiering get --id <plan-id> -o json

`synology-apm-cli activity backup`

# List ongoing backup activities (default)
synology-apm-cli activity backup list
synology-apm-cli activity backup list --limit 100
synology-apm-cli activity backup list --verbose              # add Transferred, Workload ID, and Workload Namespace columns (Activity ID shown by default)

# View completed history
synology-apm-cli activity backup list --history
synology-apm-cli activity backup list --history --limit 25 --offset 25         # page 2

# Filter options
synology-apm-cli activity backup list --status backing_up                      # single status filter
synology-apm-cli activity backup list --status failed --status partial          # multiple statuses (OR)
synology-apm-cli activity backup list --machine-type vm                        # Machine sub-type filter
synology-apm-cli activity backup list --machine-type pc --machine-type vm      # multiple sub-types (OR)
synology-apm-cli activity backup list --m365-type exchange --m365-type teams   # M365 service type filter
synology-apm-cli activity backup list --since 24h           # 30m | 1h | 24h | 7d | ISO 8601
synology-apm-cli activity backup list --until 7d           # relative time also supported for --until
synology-apm-cli activity backup list --until 2026-04-20T23:59:59

# Inspect a single activity (includes log entries)
# Search mode — latest activity for a workload by name
synology-apm-cli activity backup get "CORP-PC-001"
synology-apm-cli activity backup get "Corp Share" -o json
# Direct mode — exact lookup by Activity ID
synology-apm-cli activity backup get --id <activity-id>
synology-apm-cli activity backup get --id <activity-id> -o json

# Cancel a running backup activity (requires confirmation)
synology-apm-cli activity backup cancel --id <activity-id>
synology-apm-cli activity backup cancel --id <activity-id> --yes          # skip confirmation
synology-apm-cli activity backup cancel --id <activity-id> --yes --quiet  # no output

Tip: Activity ID is shown by default in synology-apm-cli activity backup list. Use it with synology-apm-cli activity backup get and synology-apm-cli activity backup cancel.

`synology-apm-cli activity restore`

# List ongoing restore activities (default)
synology-apm-cli activity restore list
synology-apm-cli activity restore list --limit 50
synology-apm-cli activity restore list --verbose                          # add Transferred, Workload ID, and Workload Namespace columns

# View completed history
synology-apm-cli activity restore list --history
synology-apm-cli activity restore list --history --limit 25 --offset 25         # page 2

# Filter options (restore list has no --machine-type / --m365-type filters)
synology-apm-cli activity restore list --status restoring                       # single status filter
synology-apm-cli activity restore list --status success --status failed         # multiple statuses (OR)
synology-apm-cli activity restore list --since 24h
synology-apm-cli activity restore list --until 7d           # relative time supported
synology-apm-cli activity restore list --until 2026-04-20T23:59:59

# Inspect a single restore activity (includes log entries)
# Search mode — latest restore activity for a workload by name
synology-apm-cli activity restore get "CORP-PC-001"
# Direct mode — exact lookup by Activity ID
synology-apm-cli activity restore get --id <activity-id>
synology-apm-cli activity restore get --id <activity-id> -o json

# Cancel a running restore activity (requires confirmation)
synology-apm-cli activity restore cancel --id <activity-id>
synology-apm-cli activity restore cancel --id <activity-id> --yes          # skip confirmation
synology-apm-cli activity restore cancel --id <activity-id> --yes --quiet  # no output

Tip: Activity ID is shown in synology-apm-cli activity restore list. The cancel command automatically looks up the activity details needed to call the API.

`synology-apm-cli infra`

Infrastructure information: Management Server details and backup server management.

# Show Management Server info, storage statistics, and workload usage summary
# (like all get/info commands, supports -o json / -o yaml)
synology-apm-cli infra info

# List all backup servers in the cluster
synology-apm-cli infra server list
synology-apm-cli infra server list --search "Lab"           # keyword search
synology-apm-cli infra server list --status disconnected    # filter by status
synology-apm-cli infra server list --status healthy --status warning  # multiple values allowed
synology-apm-cli infra server list --type dp                # filter by server type (dp or nas)
synology-apm-cli infra server list --type dp --type nas     # multiple values allowed
synology-apm-cli infra server list --verbose                # add Description, Server ID, Namespace columns

# Inspect a single backup server — two modes:
synology-apm-cli infra server get "apm-server-01"       # Search mode (keyword search)
synology-apm-cli infra server get --id <server-id>      # Direct mode (exact lookup by Server ID)

# List all remote storages (External Vaults)
# Usage column: "442.8 KB (341.8 GB left)" / "442.8 KB" / "-"
synology-apm-cli infra storage list
synology-apm-cli infra storage list --verbose               # add Remote Storage ID column

# Inspect a single remote storage — two modes:
synology-apm-cli infra storage get "DSM-Storage"        # Search mode (display name or endpoint)
synology-apm-cli infra storage get --id <storage-id>    # Direct mode (exact lookup by Remote Storage UUID)

# List all hypervisor inventory servers
synology-apm-cli infra hypervisor list
synology-apm-cli infra hypervisor list --verbose               # add Hypervisor ID column

# Inspect a single hypervisor — two modes:
synology-apm-cli infra hypervisor get "esxi1.example.com"    # Search mode (hostname or address)
synology-apm-cli infra hypervisor get --id <hypervisor-id>   # Direct mode (exact lookup by Hypervisor UUID)

`synology-apm-cli log`

Query server-scoped logs from a specific DP (ActiveProtect Appliance) backup server. All log commands require identifying the target backup server (by name or server ID). NAS servers are not supported.

Get the Server ID with: synology-apm-cli infra server list --verbose

# Activity logs — search mode (server name keyword)
synology-apm-cli log activity list "apm-server-01"
synology-apm-cli log activity list "apm-server-01" --level warning --level error
synology-apm-cli log activity list "apm-server-01" --type protection --since 24h
synology-apm-cli log activity list "apm-server-01" --search "copy destination"

# Activity logs — direct mode (server ID from synology-apm-cli infra server list --verbose)
synology-apm-cli log activity list --id <server-id>
synology-apm-cli log activity list --id <server-id> --since 7d --limit 100 -o json

# Drive information logs
synology-apm-cli log drive list "apm-server-01"
synology-apm-cli log drive list "apm-server-01" --level error --since 30d
synology-apm-cli log drive list --id <server-id> --location "Slot 1"
synology-apm-cli log drive list --id <server-id> -o csv

# Connection logs
synology-apm-cli log connection list "apm-server-01"
synology-apm-cli log connection list "apm-server-01" --search "signed in" --since 24h
synology-apm-cli log connection list --id <server-id> --level warning --level error

# Advanced system logs
synology-apm-cli log system list "apm-server-01"
synology-apm-cli log system list --id <server-id> --since 7d -o json

# Pagination
synology-apm-cli log activity list --id <server-id> --limit 25 --offset 25

Exit codes

Code	Meaning
`0`	Success
`1`	General error (API error, invalid argument)
`2`	Authentication failure (bad credentials, session expired)
`3`	Connection failure (host unreachable, TLS error)
`4`	Cancelled by user (confirmation prompt answered no)
`5`	Feature not supported on this APM version

Examples

Daily backup health check

#!/bin/bash
# Print any workloads that failed backup in the last 24 hours
# (--history: failed runs are in the completed history, not the ongoing list)
synology-apm-cli activity backup list --history --status failed --since 24h -o json \
  | jq -r '.[].workload_name'

Apply a plan to all retired VMs

synology-apm-cli machine list --type vm --retired -o json \
  | jq -r '.[] | "\(.workload_id) \(.namespace)"' \
  | while read -r id ns; do
      synology-apm-cli machine change-plan --id "$id" --namespace "$ns" --plan <plan-id> --yes
    done

Pipe backup server storage stats to another tool

synology-apm-cli infra server list -o json \
  | jq '[.[] | {name, used: .storage_used_bytes, total: .storage_total_bytes}]'

Use a specific profile

# Run a command against a non-default profile
synology-apm-cli --profile lab machine list
synology-apm-cli --profile dr infra server list -o json

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synology_apm_cli-0.3.0.tar.gz (74.1 kB view details)

Uploaded Jul 22, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

synology_apm_cli-0.3.0-py3-none-any.whl (79.9 kB view details)

Uploaded Jul 22, 2026 Python 3

File details

Details for the file synology_apm_cli-0.3.0.tar.gz.

File metadata

Download URL: synology_apm_cli-0.3.0.tar.gz
Upload date: Jul 22, 2026
Size: 74.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for synology_apm_cli-0.3.0.tar.gz
Algorithm	Hash digest
SHA256	`e628e7108bf09c4364ee5c395b7db2e23beb9a2b8f4407104dec0350e08b8856`
MD5	`b04668b762f9606d45477fb06443e6c2`
BLAKE2b-256	`ca934e61d64b8367b2f150c1f1948828ccda21bc3e354a963dbcfd319ccd9046`

See more details on using hashes here.

Provenance

The following attestation bundles were made for synology_apm_cli-0.3.0.tar.gz:

Publisher: release.yml on synology-apm/apm-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: synology_apm_cli-0.3.0.tar.gz
- Subject digest: e628e7108bf09c4364ee5c395b7db2e23beb9a2b8f4407104dec0350e08b8856
- Sigstore transparency entry: 2217083544
- Sigstore integration time: Jul 22, 2026
Source repository:
- Permalink: synology-apm/apm-sdk-python@6bdbeb2948359bc83fbed59978d792d22ae8f956
- Branch / Tag: refs/tags/v0.3.0
- Owner: https://github.com/synology-apm
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@6bdbeb2948359bc83fbed59978d792d22ae8f956
- Trigger Event: push

File details

Details for the file synology_apm_cli-0.3.0-py3-none-any.whl.

File metadata

Download URL: synology_apm_cli-0.3.0-py3-none-any.whl
Upload date: Jul 22, 2026
Size: 79.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for synology_apm_cli-0.3.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`a8354cb72fbf9b302731f4eba9d16f9a822f0b3e632a673b08c2e50cae43405b`
MD5	`b5f2975ca46a2897b8f7e53c7858d9e4`
BLAKE2b-256	`b539ef1f7bcc210a8ddaa949970f434be29c4d4241fd87874fb9d0d745046e00`

See more details on using hashes here.

Provenance

The following attestation bundles were made for synology_apm_cli-0.3.0-py3-none-any.whl:

Publisher: release.yml on synology-apm/apm-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: synology_apm_cli-0.3.0-py3-none-any.whl
- Subject digest: a8354cb72fbf9b302731f4eba9d16f9a822f0b3e632a673b08c2e50cae43405b
- Sigstore transparency entry: 2217083569
- Sigstore integration time: Jul 22, 2026
Source repository:
- Permalink: synology-apm/apm-sdk-python@6bdbeb2948359bc83fbed59978d792d22ae8f956
- Branch / Tag: refs/tags/v0.3.0
- Owner: https://github.com/synology-apm
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@6bdbeb2948359bc83fbed59978d792d22ae8f956
- Trigger Event: push

Release history Release notifications | RSS feed

0.4.1

Sep 11, 2026 2 files

0.4.0

Sep 2, 2026 2 files

0.3.1

Jul 28, 2026 2 files

This release

0.3.0 This release

Jul 22, 2026 2 files

0.2.1

Jul 18, 2026 2 files

0.2.0

Jul 17, 2026 2 files

0.1.0

Jul 7, 2026 2 files

synology-apm-cli 0.3.0

APM CLI — Command Reference

Installation

Authentication

Config file — recommended

Environment variables

Global flags (before the subcommand)

Output formats

Debugging

Commands

synology-apm-cli machine

synology-apm-cli machine list

synology-apm-cli machine get

synology-apm-cli machine backup

synology-apm-cli machine cancel

synology-apm-cli machine retire

synology-apm-cli machine change-plan

synology-apm-cli machine version list

synology-apm-cli machine version get

synology-apm-cli machine version lock / unlock

synology-apm-cli saas

synology-apm-cli m365

synology-apm-cli plan

synology-apm-cli plan protection

synology-apm-cli plan retirement

synology-apm-cli plan tiering

synology-apm-cli activity backup

synology-apm-cli activity restore

synology-apm-cli infra

synology-apm-cli log

Exit codes

Examples

Daily backup health check

Apply a plan to all retired VMs

Pipe backup server storage stats to another tool

Use a specific profile

Project links

Key dates

1 maintainer

Credits

GitHub Statistics

License expression

Requires

Tags

Classifiers

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

Release history Release notifications | RSS feed

`synology-apm-cli machine`

`synology-apm-cli machine list`

`synology-apm-cli machine get`

`synology-apm-cli machine backup`

`synology-apm-cli machine cancel`

`synology-apm-cli machine retire`

`synology-apm-cli machine change-plan`

`synology-apm-cli machine version list`

`synology-apm-cli machine version get`

`synology-apm-cli machine version lock` / `unlock`

`synology-apm-cli saas`

`synology-apm-cli m365`

`synology-apm-cli plan`

`synology-apm-cli plan protection`

`synology-apm-cli plan retirement`

`synology-apm-cli plan tiering`

`synology-apm-cli activity backup`

`synology-apm-cli activity restore`

`synology-apm-cli infra`

`synology-apm-cli log`