Request contents (DELETE purge object)

The DELETE request to purge an object has these elements:

If you’re accessing the namespace as an authenticated user, an Authorization header

The URL of the object

A purge=true URL query parameter

To perform a privileged purge, the request must specify these parameters:

privileged=true
reason=reason-text

reason-text must be from one through 1,024 characters long and can contain any valid UTF-8 characters, including white space.

You can specify the parameters in either of these ways:

As query parameters at the end of the URL, in this format:

?purge=true&privileged=true&reason=reason-text

As form-encoded data (application/x-www-form-urlencoded content type) in the request. For example, in cURL, you can use the -d option to specify each parameter in a DELETE request.

These considerations apply:

If you use query parameters, you need to percent-encode characters in the reason parameter that have special meanings in URLs. For more information about percent-encoding, see URL considerations.

If you use form-encoded data, you need to percent-encode only ampersand (&) characters in the reason parameter. This prevents HCP from interpreting these characters as starting a new URL parameter.

You cannot combine query parameters and form-encoded data in a single request.

© 2015, 2020 Hitachi Vantara LLC. All rights reserved.