Preferences Operations Delete All

Preferences Operations Delete All
Delete all user preferences

Resets all stored user preferences to their default states. Accessible to every authenticated role. The path /api/v1/users/preferences is an alias of /api/v1/user/preferences for every method. Answers 204 also when no preference is stored.

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

204 No Content successful response. All stored preferences of the signed-in user are removed

Operation doesn't return any data structure

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 -X DELETE -H 'Authorization: <value>' https://{api_host}/api/v1/user/preferences