Dell Technologies ECS REST API

Search (SHIFT+S)




Get Legal Hold

GET /{object_name}?lehal-hold&versionId={version_id}

Gets an object's current Legal Hold status.

URL Format

Host Style: http://bucketname.ns1.emc.com/{object_name}?lehal-hold&versionId={version_id}
Path Style: http://ns1.emc.com/bucketname/{object_name}?lehal-hold&versionId={version_id}

Alternatively, both styles can specify the namespace using the x-emc-namespace header.
Owner in the payload refers to the object owner.


Prerequisites

The following conditions must be met in order to call this operation.

  • User should have READ_ACP permission

  • BaseUrl used in a host-style request URL should be pre-configured using the ECS Management API or the ECS Portal (for example, emc.com in the URL: bucketname.ns1.emc.com).

  • Namespace and bucket corresponding to this object should exist


Response Body

Field Description Type Notes
LegalHold
Status Indicates whether the specified object has a Legal Hold in place. String Valid Values:
  •  ON | OFF