Preferences Operations Set Preferences
Persists or merges user preferences 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. Preference keys are free-form (no allow-list; 1 to 256 characters, the console itself uses names such as tabs.
A JSON object of preference keys to values. Each key is stored or replaced for the signed-in user, keys with a blank name are ignored and keys that are not listed are left unchanged.
{
"table.hypervisors.columns": {
"order": [
"name",
"status"
],
"visibility": {
"name": true,
"status": true
}
}
}
200 OK successful response envelope. All stored preferences of the signed-in user after the update
{
"panels.licensing.hosts": true,
"table.hypervisors.columns": {
"order": [
"name",
"status"
],
"visibility": {
"name": true,
"status": true
}
}
}
400 Bad Request: MALFORMED_REQUEST when the body cannot be read as a JSON object
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v1/user/preferences