Return deployed cPAddons instances

This function lists an account's deployed cPAddons instances.

SecurityBasicAuth

Request

query Parameters

addon

string

The cPAddon for which to return the instances data.

Example: addon=cPanel::Blogs::WordPressX

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/cPAddons/list_addon_instances

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  cPAddons \
  list_addon_instances

Response samples

application/json

{"apiversion": 3,
"func": "list_addon_instances",
"module": "cPAddons",
"result": {"data": [{"addon": "cPanel::Blogs::WordPressX",
"domain": "example.com",
"installdir": "/home/example/public_html/wordpress",
"instance": "cPanel::Blogs::WordPressX.0",
"unique_id": "cPanel::Blogs::WordPressX.0.1486754861"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}