PutObjectLegalHold

Available in Classic and VPC

Set or remove the legal hold status set on an Ncloud Storage object. Objects subject to legal hold cannot be deleted or changed, regardless of the retention period.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
PUT	/{Key}

Request headers

The following describes the request headers.

Note

For information about the headers common to all Ncloud Storage APIs, see Ncloud Storage request headers.

Field	Required	Description
`Content-MD5`	Required	Base64-encoded 128-bit MD5 hash of the request body Used to verify the integrity of the request body. Can be replaced with `x-amz-checksum-*` checksum header.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`Key`	String	Required	Object name

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`versionId`	String	Optional	Version ID of the object to set the legal hold for Set to the latest version if not entered.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`LegalHold`	Object	Required	Legal hold settings
`LegalHold.Status`	String	Required	Legal hold status `ON` \| `OFF` `ON`: Enabled `OFF`: Disabled

Request example

The request example is as follows:

PUT /object.csv?legal-hold HTTP/1.1
Host: {Bucket}.kr.ncloudstorage.com
Content-MD5: {MD5 hash value}

<?xml version="1.0" encoding="UTF-8"?>
<LegalHold>
    <Status>ON</Status>
</LegalHold>

Response

This section describes the response format.

Response headers

For information about the headers common to all Ncloud Storage APIs, see Ncloud Storage response headers.

Response status codes

The following describes the response status codes.