Skip to main content

Apply Legal hold (Object)

This API allows users to apply legal hold to an object.

POST/api/v1/storage/buckets/{bucket_name}/legalhold/object/

Path parameters

  • bucket_namePathstringrequired

    Bucket Name

Query parameters

  • object_nameQuerystringrequired

    Object Name with Directory.

  • project_idQueryintegerrequired
  • locationQuerystringrequired

    Deployment region for the resource. Accepted values: Delhi, Chennai.

    Mumbai region has been discontinued. Delhi and Chennai are the only supported regions.

  • version_idQuerystringrequired

    Version ID

Request body

application/json

object
object_namestring
exampleobject_name
version_idstring
example25273eed-1234-4bd2-96a1-a43a3aa44e43

Responses

200Response indicating the legal hold status of the object or bucket
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess