Return deployed cPAddons instance's settings

This function lists a cPAddons instance's settings.

Authorizations:
query Parameters
unique_id
required
string

The unique identifier of the cPAddon.

Note:

To find this identifier, run the list_addon_instances function.

Example: unique_id=cPanel::Blogs::WordPressX.0.1486754861

Responses

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

Request samples

uapi --output=jsonpretty \
  --user=username \
  cPAddons \
  get_instance_settings \
  unique_id='cPanel::Blogs::WordPressX.0.1486754861'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_instance_settings",
  • "module": "cPAddons",
  • "result": {
    • "data": {
      • "addon": "cPanel::Blogs::WordPressX",
      • "admin_user": "string",
      • "autoupdate": 0,
      • "db_name": "example_wp",
      • "db_type": "mysql",
      • "db_user": "example_wp",
      • "domain": "example.com",
      • "installdir": "/home/example/public_html/wordpress",
      • "url_to_install": "http://example.com/wordpress/"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}