DELETE Preferences

Removes user preferences of the caller. The change applies only to the caller's preferences.

Requirements

  • Permissions: The caller is not required to have any special permissions.
  • Token scope:  Any valid scope, such as Agent, Certificate, or SSH

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer xxxxxx==. For more information, see Passing a bearer token in your API calls.

Parameters

CAUTION  If you call this API without any parameters, it clears all of the caller's preference settings.

Specify one or more of the following parameters. To get these values, call GET Preferences.

Input parameters

Name

Description

Category

(Optional) The global or custom preference category. For example, Dashboard.

Name

(Optional) The preference name.

Product

(Optional) A Palo Alto Networks product:

  • Code Sign Manager
  • Platform
  • SSH Manager
  • Certificate Manager

Returns

For an invalid request, DELETE Preferences returns a HTTP 400 Bad Request. Otherwise, this API call returns a HTTP 200 OK. 

Example: Clear some of the caller's user preferences

Request for Example

DELETE https://tpp.venafi.example/vedsdk/Preferences?Category=Dashboard&
Name=ssh-dashboard
Authorization:Bearer xxxxxx==

Response for Example

HTTP/1.1 200 OK
{
  
}