Command Api
AriaNg provides command line api for third-party application to call AriaNg functions conveniently. You can navigate to http(s)://AriaNgUrl/#!/command_api/parameters_1/.../parameters_n or http(s)://AriaNgUrl/#!/command_api?parameters_key_1=parameters_1&...¶meters_key_n=parameters_n to call command api.
New Task
Syntax:
/#!/new/${encoded_url}
or
/#!/new/task?url=${encoded_url}&${option_key_1}=${option_value_1}&...&${option_key_n}=${option_value_n}
- ${encoded_url} is download url which is encoded by url-safe base64.
- ${option_key}, ${option_value} is the key and value of aria2 option for creating task, optional.
Example:
/#!/new/aHR0cHM6Ly9naXRodWIuY29tL21heXN3aW5kL0FyaWFOZy1EYWlseUJ1aWxkL2FyY2hpdmUvbWFzdGVyLnppcA==
or
/#!/new/task?url=aHR0cHM6Ly9naXRodWIuY29tL21heXN3aW5kL0FyaWFOZy1EYWlseUJ1aWxkL2FyY2hpdmUvbWFzdGVyLnppcA==
/#!/new/task?url=aHR0cHM6Ly9naXRodWIuY29tL21heXN3aW5kL0FyaWFOZy1EYWlseUJ1aWxkL2FyY2hpdmUvbWFzdGVyLnppcA==&max-download-limit=100K
Set Rpc Setting
Syntax:
/#!/settings/rpc/set/${protocol}/${rpcHost}/${rpcPort}/${rpcInterface}/${secret}
or
/#!/settings/rpc/set?protocol=${protocol}&host=${rpcHost}&port=${rpcPort}&interface=${rpcInterface}&secret=${secret}
- ${protocol} is connection protocol. You can use http, https, ws or wss.
- ${rpcHost} is aria2 rpc host. You can use ip or domain name.
- ${rpcPort} is aria2 rpc port.
- ${rpcInterface} is aria2 rpc path. The default is "jsonrpc".
- ${secret} is rpc secret which is encoded by url-safe base64, optional.
Example:
/#!/settings/rpc/set/http/127.0.0.1/6800/jsonrpc
or
/#!/settings/rpc/set?protocol=http&host=127.0.0.1&port=6800&interface=jsonrpc