Ransomware attackers specifically target and attempt to destroy backup systems to increase the probability of payment. Hardening your system is critical. Please ensure you have reviewed your platform security using the Security Hardening Checklist
Cohesity

COHESITY Documentation

Explore our documentation to get started, discover products & new features, access troubleshooting guides, register sources, platforms support.

Products
Data Security Alliance
Visit Cohesity.com
Demos
Support
Blogs
Developers
Partner Portals
Cohesity Community
© 2026 Cohesity, Inc. All Rights Reserved.
Terms of Use|
Privacy Policy|
Legal|
  1. Home
  2. NetBackup™ Deduplication Guide
  3. S3 Interface for MSDP
  4. S3 APIs for S3 interface for MSDP
  5. S3 APIs on Objects
  6. Get Object Retention (Flex WORM only)
NetBackup™ Deduplication Guide

Get Object Retention (Flex WORM only)

Retrieves an object's retention settings.

Request Syntax

GET /{bucket}/Key+?retention&versionId=VersionId HTTP/1.1 Host: msdps3.server:8443

Request Parameters

  • Bucket

    The bucket name that contains the object for which you want to retrieve the retention settings.

    Required: Yes

    Type: String

  • Key

    The key name for the object for which you want to retrieve the retention settings.

    Required: Yes

    Type: String

  • versionId

    The version ID for the object for which you want to retrieve the retention settings.

    Type: String

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<Retention>
   <Mode>string</Mode>
   <RetainUntilDate>timestamp</RetainUntilDate>
</Retention>

Response Body

  • Retention

    Root level tag for the Retention parameters.

    Required: Yes

  • Mode

    Indicates the Retention mode for the specified object.

    Valid Values: GOVERNANCE, COMPLIANCE

    Type: String

  • RetainUntilDate

    The date on which this Object Lock Retention expires.

    Type: Timestamp

Possible Error Response

  • Success

    HTTP status code 200.

  • InvalidArgument

    Invalid Argument. Invalid version id specified.

    HTTP status code 400.

  • AccessDenied

    Request was rejected because user authentication failed.

    HTTP status code 403.

  • NoSuchKey

    The specified key does not exist.

    HTTP status code 404.

  • NoSuchBucket

    The specified bucket does not exist.

    HTTP status code 404.

Feedback

Was this page helpful?
Previous

Put Object Retention (Flex WORM only)

Next

The naming rules for buckets and objects

Feedback

Was this page helpful?