CPcpanel
UserData

Get scoped userdata

This function retrieves all userdata key/value pairs within the specified scope.

get/get_scoped_userdata

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

scopestring required
Example:example_scope

The scope name whose userdata you wish to retrieve.

Response

HTTP Request was successful.

dataobject

A mapping of userdata keys to their string values for the given scope.

Example response

{
  "data": {
    "theme": "dark",
    "items_per_page": "50"
  },
  "metadata": {
    "command": "get_scoped_userdata",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.