Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Intertech Services AG
Yandex Object Storage
  • Getting started
  • Step-by-step instructions
  • Tutorials
  • Concepts
  • Tools
  • API reference
    • REST (Amazon S3-compatible)
      • How to use the API
      • Signing requests
      • REST
        • All services and methods
        • Bucket
        • Object
          • All methods
          • upload
          • get
          • copy
          • getObjectMeta
          • delete
          • deleteMultipleObjects
          • options
          • selectObjectContent
          • putObjectRetention
          • putObjectLegalHold
          • getObjectRetention
          • getObjectLegalHold
        • Multipart upload
        • Static Website Hosting
        • CORS
        • Lifecycles
        • ACL
        • Bucket Policy
        • Common request headers
        • Common response headers
        • Responses
    • gRPC and REST
  • Access management
  • Pricing policy
  • Questions and answers
  1. API reference
  2. REST (Amazon S3-compatible)
  3. REST
  4. Object
  5. getObjectLegalHold

getObjectLegalHold method

Written by
Yandex Cloud
  • Request
    • Path parameters
    • Query parameters
    • Headers
  • Response
    • Headers
    • Response codes
    • Data schema

Returns the settings of legal hold put on the object version.

Request

GET /{bucket}/{key}?legal-hold&versionId={versionId} HTTP/2

Path parameters

Parameter Description
bucket Bucket name.
key Object key.

Query parameters

Parameter Description
legal-hold Required parameter that indicates the type of operation.
versionId Object version ID. Required parameter.

Headers

Use the necessary common request headers in requests.

Response

Headers

Responses can only contain common response headers.

Response codes

For a list of possible responses, see Responses.

Data schema

<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Status>string</Status>
</LegalHold>
Element Description
Status

Status of legal hold:

  • ON: Enabled.
  • OFF: Disabled.

Path: LegalHold\Status.

Was the article helpful?

Language / Region
Yandex project
© 2023 Intertech Services AG
In this article:
  • Request
  • Path parameters
  • Query parameters
  • Headers
  • Response
  • Headers
  • Response codes
  • Data schema