Get scoped userdata

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

SecurityBasicAuth
Request
query Parameters
scope
required
string

The scope name whose userdata you wish to retrieve.

Example: scope=example_scope
Responses
200

HTTP Request was successful.

Response Schema: application/json
object

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

object
get/get_scoped_userdata
Request samples
whmapi1 --output=jsonpretty \
  get_scoped_userdata \
  scope='example_scope'
Response samples
application/json
{
  • "data": {
    • "theme": "dark",
    • "items_per_page": "50"
    },
  • "metadata": {
    • "command": "get_scoped_userdata",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}