Exploration of Synology NAS Web APIs. The aim is to be able to automate management initially of images and VMs, later of Docker images and containers.
The Synology Web API documentation is not straightforward to follow. The higher level abstractions in terraform providers and in Python APIs do not yet seem mature for these use cases. Initially understanding repeatable actions at the API level will help with making the higher level scenarios work.
The API discovery is based on using the REST Client Visual Studio Code extension.
Create a .env file in the project directory and populate with the following environment variables, populated with appropriate values.
SYNOLOGY_IP_ADDRESS=192.168.x.y
SYNOLOGY_PROTO=http
SYNOLOGY_PORT=5000
SYNOLOGY_USERNAME=user
SYNOLOGY_PASSWORD=password- Many endpoints to add here
- Create VM image not yet working
- Python API N4S4/synology-api
- Terraform provider synology-community/synology
- Synology Virtual Machine Manager API Guide