Preferences Operations Get Preferences

Preferences Operations Get Preferences
Get all user preferences

Returns all personal preferences (such as table column customisations) for the authenticated user. Accessible to every authenticated role. The path /api/v1/users/preferences is an alias of /api/v1/user/preferences for every method. The result is one JSON object keyed by preference key, empty when nothing is stored; a stored value that does not parse as JSON is returned as its raw string.

Request
URI
GET
https://{api_host}/api/v1/user/preferences
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The preferences of the signed-in user as one JSON object keyed by preference key, empty when none are stored

{
    "panels.licensing.hosts": true
}

401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/user/preferences