synology-dsm

# Synology DSM Skill

Interact with a Synology NAS through the DSM Web API using `curl`.

## Prerequisites

The user must have these environment variables set (or provide them inline):

- `SYNOLOGY_HOST` — NAS hostname or IP (e.g., `192.168.1.100`)
- `SYNOLOGY_PORT` — DSM port (`5000` for HTTP, `5001` for HTTPS)
- `SYNOLOGY_USER` — DSM username
- `SYNOLOGY_PASS` — DSM password

Base URL: `http://$SYNOLOGY_HOST:$SYNOLOGY_PORT/webapi`

> **Security**: Always prefer HTTPS (port 5001). Never hardcode credentials in commands shown to the user — use `$SYNOLOGY_PASS` references. If the user hasn't set env vars, ask them to provide connection details.

## Step 1: Authentication

Every session starts with login. Use `format=sid` to get a session ID.

### Login

```bash
curl -s "http://$SYNOLOGY_HOST:$SYNOLOGY_PORT/webapi/entry.cgi?\
api=SYNO.API.Auth&version=6&method=login\
&account=$SYNOLOGY_USER&passwd=$SYNOLOGY_PASS\
&session=FileStation&format=sid" | jq .
```

Response:
```json
{"data": {"sid": "YOUR_SESSION_ID"}, "success": true}
```

Save the `sid` for all subsequent requests: `SID=<value from response>`

### Logout

```bash
curl -s "http://$SYNOLOGY_HOST:$SYNOLOGY_PORT/webapi/entry.cgi?\
api=SYNO.API.Auth&version=6&method=logout\
&session=FileStation&_sid=$SID"
```

### 2FA Handling

If login returns error code `406`, the account has 2FA enabled. Ask the user for their OTP code, then include `&otp_code=<CODE>` in the login request.

### Session Notes

- Sessions timeout after ~15 minutes of inactivity
- If you get error code `106` (session timeout), re-authenticate
- Always logout when done to clean up sessions

## Step 2: API Discovery (Optional)

Query all available APIs on the NAS:

```bash
curl -s "http://$SYNOLOGY_HOST:$SYNOLOGY_PORT/webapi/query.cgi?\
api=SYNO.API.Info&version=1&method=query" | jq .
```

This returns every API name, path, and supported version range. Useful for checking what packages are installed.

## Step 3: FileStation — File Management

All...