Skip to main content

API Reference

srvly exposes both tRPC (internal) and REST (agent-facing) endpoints.

REST Endpoints

EndpointMethodDescription
/api/deployGETDownload the all-in-one server setup script
/api/agent/skill/[token]GETDownload the agent skill prompt (raw text)
/api/agent/openapi.jsonGETOpenAPI 3.0 specification
/api/agent/serversGETList servers accessible to the agent
/api/agent/servers/[id]/containersGETList Docker containers on a server
/api/agent/docker/deployPOSTDeploy a Docker app on a server
/api/agent/installGETList installations on a server
/api/agent/install/registerPOSTRegister an installation
/api/agent/install/logsPOSTFetch Docker container logs
/api/agent/install/execPOSTRun commands in a container
/api/agent/install/restartPOSTRestart an installation
/api/agent/install/stopPOSTStop an installation
/api/agent/install/startPOSTStart a stopped installation
/api/agent/install/deletePOSTDelete an installation
/api/agent/files/readPOSTRead a file on a server
/api/agent/files/writePOSTWrite a file on a server
/api/agent/proxy/configurePOSTConfigure Caddy/Nginx reverse proxy
/api/domains/enable-sslPOSTEnable SSL for a domain
/api/dispatchPOSTExecute SSH commands on a server

Base URL

All endpoints are relative to your srvly instance:

https://console.srvly.app/api/...

For self-hosted instances, replace with your own domain.