Home

Extended documentation to the DNP_ADMIN

Call specifications

Reply specifications

The response is a stringified object always contains three keys:

{
  success: true / false
  message: 'Error: package not found'
  result: <object, array or string>
}

VPN

domain: <event>.vpn.dnp.dappnode.eth

event	kwargs	result
addDevice	id	{}
removeDevice	id	{}
toggleAdmin	id	{}
listDevices	-	[{ deviceObject }]
getParams	-	{param: paramValue, ...}
statusUPnP	-	{openPorts, UPnP, msg}
statusExternalIp	-	{externalIpResolves, attempts, INT_IP, EXT_IP}

deviceObject

{
    name: 'string',
    password: 'string',
    ip: 'string'
}

Installer

domain: <event>.dappmanager.dnp.dappnode.eth

event	kwargs	result
installPacakge	id	{}
removePackage	id, deleteVolumes	{}
togglePackage	id, timeout	{}
restartPackage	id	{}
restartPackageVolumes	id	{}
updatePackageEnv	id, envs, restart, isCore	{}
logPackage	id, options	{id, logs}
fetchPackageVersions	id	[{ versionObject }]
fetchPackageData	id	{manifest, avatar}
listPackages	-	[{ pkgDataObject }]
fetchDirectory	-	[{name, status}]

pkgDataObject

{
  id: '927623894...', (string)
  isDNP: true, (boolean)
  created: date (string),
  image: imageName, (string)
  name: otpweb.dnp.dappnode.eth, (string)
  shortName: otpweb, (string)
  version: '0.0.4', (string)
  ports: listOfPorts, (string)
  state: 'exited', (string)
  running: true, (boolean)
  ...
  envs: envVariables (object)
}

versionObject

{
  version: '0.0.4', (string)
  manifest: manifest (object)
}