Object Lock

Object Lock Configuration

GetObjectLockConfiguration

get

https://s3.eu-central-3.ionoscloud.comhttps://s3.us-central-1.ionoscloud.com

/{Bucket}?object-lock

Retrieves the Object Lock configuration for a bucket.

Permissions

You must be the contract owner or an administrator to perform this operation. If not, they can grant you permission to perform the s3:GetBucketObjectLockConfiguration operation using Bucket Policy.

Authorizations

hmac

AuthorizationstringRequired

IONOS Object Storage API requests are authenticated using the AWS signature. The IONOS Object Storage API authenticates users using a customized HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code). The process of generating the proper Authorization header is somewhat involved. We recommend that you make use of a tool such as Postman.

In the Authorization tab for a request, select AWS Signature from the Type dropdown list. Specify where Postman should append your authorization data using the Add authorization data to drop-down menu.

• If you select Request Headers, Postman populates the Headers tab with Authorization and X-Amz- prefixed fields.

• If you select Request URL, Postman populates the Params tab with authentication details prefixed with X-Amz-.

Note: The parameters listed below contain confidential information. We recommend using variables to keep this data secure while working in a collaborative environment.

• For Access Key, enter your access key directly in the fields or through variables for added security.

• For Secret Key, enter your secret key directly in the fields or through variables for added security.

Advanced fields are optional, but Postman will attempt to generate them automatically if necessary.

• For AWS Region, enter one of the regions (eu-central-3) where your bucket is hosted.

• For Service Name, enter s3. The name of the service that receives the requests.

• For Session Token, leave the field blank. This is only required when temporary security credentials are used.

Path parameters

Bucketstring · min: 3 · max: 63Required

The bucket name.

Example: my-bucket

Query parameters

object-lockboolean · enumRequiredPossible values:

Responses

200

Successful operation

application/xml

403

AccessDenied

application/xml

404

ObjectLockConfigurationNotFoundError, NoSuchBucket or NoSuchKey

application/xml

get

/{Bucket}?object-lock

HTTPcURLJavaScriptPython

GET /{Bucket}?object-lock?object-lock=true HTTP/1.1
Host: s3.eu-central-3.ionoscloud.com
Authorization: YOUR_API_KEY
Accept: */*

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration>
    <ObjectLockEnabled>Enabled</ObjectLockEnabled>
    <Rule>
        <DefaultRetention>
            <Mode>GOVERNANCE</Mode>
            <Days>10</Days>
        </DefaultRetention>
    </Rule>
</ObjectLockConfiguration>

PutObjectLockConfiguration

put

https://s3.eu-central-3.ionoscloud.comhttps://s3.us-central-1.ionoscloud.com

/{Bucket}?object-lock

Applies an Object Lock configuration on the specified bucket, which requires the Object Lock feature to have been enabled during its creation. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

Note:

• An Object Lock Configuration can only be applied to buckets with Object Lock enabled.

• This feature can only be activated on a new bucket during its creation.

• Object Lock cannot be enabled on a bucket that already exists.

Permissions

You must be the contract owner or an administrator to perform this operation. If not, they can grant you permission to perform the s3:PutBucketObjectLockConfiguration operation using Bucket Policy.

Authorizations

hmac

AuthorizationstringRequired

IONOS Object Storage API requests are authenticated using the AWS signature. The IONOS Object Storage API authenticates users using a customized HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code). The process of generating the proper Authorization header is somewhat involved. We recommend that you make use of a tool such as Postman.

In the Authorization tab for a request, select AWS Signature from the Type dropdown list. Specify where Postman should append your authorization data using the Add authorization data to drop-down menu.

• If you select Request Headers, Postman populates the Headers tab with Authorization and X-Amz- prefixed fields.

• If you select Request URL, Postman populates the Params tab with authentication details prefixed with X-Amz-.

Note: The parameters listed below contain confidential information. We recommend using variables to keep this data secure while working in a collaborative environment.

• For Access Key, enter your access key directly in the fields or through variables for added security.

• For Secret Key, enter your secret key directly in the fields or through variables for added security.

Advanced fields are optional, but Postman will attempt to generate them automatically if necessary.

• For AWS Region, enter one of the regions (eu-central-3) where your bucket is hosted.

• For Service Name, enter s3. The name of the service that receives the requests.

• For Session Token, leave the field blank. This is only required when temporary security credentials are used.

Path parameters

Bucketstring · min: 3 · max: 63Required

The bucket name.

Example: my-bucket

Query parameters

object-lockboolean · enumRequiredPossible values:

Header parameters

Content-MD5stringRequired

The base64 encoded MD5 digest of the message (without the headers) according to RFC 1864.

Body

application/xml

Responses

200

Successful operation

application/xml

400

MalformedXML

application/xml

403

AccessDenied

application/xml

409

InvalidBucketState

application/xml

put

/{Bucket}?object-lock

HTTPcURLJavaScriptPython

PUT /{Bucket}?object-lock?object-lock=true HTTP/1.1
Host: s3.eu-central-3.ionoscloud.com
Authorization: YOUR_API_KEY
Content-MD5: text
Content-Type: application/xml
Accept: */*
Content-Length: 351

"<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <ObjectLockEnabled>Enabled</ObjectLockEnabled>
    <Rule>
        <DefaultRetention>
            <Mode>GOVERNANCE</Mode>
            <Days>15</Days>
        </DefaultRetention>
    </Rule>
</ObjectLockConfiguration>
"

Enable Governance modeEnable Compliance mode

No content

GetObjectRetention

get

https://s3.eu-central-3.ionoscloud.comhttps://s3.us-central-1.ionoscloud.com

/{Bucket}/{Key}?retention

Retrieves an object's retention configuration.

Permissions

You must be the contract owner or an administrator to perform this operation. If not, they can grant you permission to perform the s3:GetObjectRetention operation using Bucket Policy.

Authorizations

hmac

AuthorizationstringRequired

IONOS Object Storage API requests are authenticated using the AWS signature. The IONOS Object Storage API authenticates users using a customized HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code). The process of generating the proper Authorization header is somewhat involved. We recommend that you make use of a tool such as Postman.

In the Authorization tab for a request, select AWS Signature from the Type dropdown list. Specify where Postman should append your authorization data using the Add authorization data to drop-down menu.

• If you select Request Headers, Postman populates the Headers tab with Authorization and X-Amz- prefixed fields.

• If you select Request URL, Postman populates the Params tab with authentication details prefixed with X-Amz-.

Note: The parameters listed below contain confidential information. We recommend using variables to keep this data secure while working in a collaborative environment.

• For Access Key, enter your access key directly in the fields or through variables for added security.

• For Secret Key, enter your secret key directly in the fields or through variables for added security.

Advanced fields are optional, but Postman will attempt to generate them automatically if necessary.

• For AWS Region, enter one of the regions (eu-central-3) where your bucket is hosted.

• For Service Name, enter s3. The name of the service that receives the requests.

• For Session Token, leave the field blank. This is only required when temporary security credentials are used.

Path parameters

Bucketstring · min: 3 · max: 63Required

The bucket name.

Example: my-bucket

Keystring · min: 1Required

The key name of the object whose retention settings you want to retrieve.

Query parameters

retentionboolean · enumRequiredPossible values:

versionIdstringOptional

The version ID of the object whose retention settings you want to retrieve.

Responses

200

Successful operation

application/xml

400

InvalidRequest

application/xml

403

AccessDenied

application/xml

404

NoSuchBucket or NoSuchKey

application/xml

get

/{Bucket}/{Key}?retention

HTTPcURLJavaScriptPython

GET /{Bucket}/{Key}?retention?retention=true HTTP/1.1
Host: s3.eu-central-3.ionoscloud.com
Authorization: YOUR_API_KEY
Accept: */*

<?xml version="1.0" encoding="UTF-8"?>
<Retention xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Mode>GOVERNANCE</Mode>
    <RetainUntilDate>2023-08-09T09:01:01Z</RetainUntilDate>
</Retention>

PutObjectRetention

put

https://s3.eu-central-3.ionoscloud.comhttps://s3.us-central-1.ionoscloud.com

/{Bucket}/{Key}?retention

Places an Object Retention configuration on an object.

Permissions

You must be the contract owner or an administrator to perform this operation. If not, they can grant you permission to perform the s3:PutObjectRetention operation using Bucket Policy. Bypassing a Governance Retention configuration also requires the s3:BypassGovernanceRetention permission.

Authorizations

hmac

AuthorizationstringRequired

IONOS Object Storage API requests are authenticated using the AWS signature. The IONOS Object Storage API authenticates users using a customized HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code). The process of generating the proper Authorization header is somewhat involved. We recommend that you make use of a tool such as Postman.

In the Authorization tab for a request, select AWS Signature from the Type dropdown list. Specify where Postman should append your authorization data using the Add authorization data to drop-down menu.

• If you select Request Headers, Postman populates the Headers tab with Authorization and X-Amz- prefixed fields.

• If you select Request URL, Postman populates the Params tab with authentication details prefixed with X-Amz-.

Note: The parameters listed below contain confidential information. We recommend using variables to keep this data secure while working in a collaborative environment.

• For Access Key, enter your access key directly in the fields or through variables for added security.

• For Secret Key, enter your secret key directly in the fields or through variables for added security.

Advanced fields are optional, but Postman will attempt to generate them automatically if necessary.

• For AWS Region, enter one of the regions (eu-central-3) where your bucket is hosted.

• For Service Name, enter s3. The name of the service that receives the requests.

• For Session Token, leave the field blank. This is only required when temporary security credentials are used.

Path parameters

Bucketstring · min: 3 · max: 63Required

The bucket name.

Example: my-bucket

Keystring · min: 1Required

The key name of the object to which you want to apply the Object Retention configuration.

Query parameters

retentionboolean · enumRequiredPossible values:

versionIdstringOptional

The version ID of the object to which you want to apply the Object Retention configuration.

Header parameters

x-amz-bypass-governance-retentionbooleanOptional

Indicates whether this operation should bypass Governance mode's restrictions.

Default: false

Content-MD5stringOptional

The base64 encoded MD5 digest of the message (without the headers) according to RFC 1864.

Body

application/xml

Responses

200

Successful operation

application/xml

400

InvalidRequest or MalformedXML

application/xml

403

AccessDenied or ObjectLockAccessDenied

application/xml

404

NoSuchBucket or NoSuchKey

application/xml

put

/{Bucket}/{Key}?retention

HTTPcURLJavaScriptPython

PUT /{Bucket}/{Key}?retention?retention=true HTTP/1.1
Host: s3.eu-central-3.ionoscloud.com
Authorization: YOUR_API_KEY
Content-Type: application/xml
Accept: */*
Content-Length: 213

"<?xml version="1.0" encoding="UTF-8"?>
<Retention xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Mode>GOVERNANCE</Mode>
    <RetainUntilDate>2023-08-10T09:01:01Z</RetainUntilDate>
</Retention>
"

Payload for the Governance modePayload for the Compliance mode

No content

GetObjectLegalHold

get

https://s3.eu-central-3.ionoscloud.comhttps://s3.us-central-1.ionoscloud.com

/{Bucket}/{Key}?legal-hold

Gets an object's current Legal Hold status.

Permissions

You must be the contract owner or an administrator to perform this operation. If not, they can grant you permission to perform the s3:GetObjectLegalHold operation using Bucket Policy.

Authorizations

hmac

AuthorizationstringRequired

IONOS Object Storage API requests are authenticated using the AWS signature. The IONOS Object Storage API authenticates users using a customized HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code). The process of generating the proper Authorization header is somewhat involved. We recommend that you make use of a tool such as Postman.

In the Authorization tab for a request, select AWS Signature from the Type dropdown list. Specify where Postman should append your authorization data using the Add authorization data to drop-down menu.

• If you select Request Headers, Postman populates the Headers tab with Authorization and X-Amz- prefixed fields.

• If you select Request URL, Postman populates the Params tab with authentication details prefixed with X-Amz-.

Note: The parameters listed below contain confidential information. We recommend using variables to keep this data secure while working in a collaborative environment.

• For Access Key, enter your access key directly in the fields or through variables for added security.

• For Secret Key, enter your secret key directly in the fields or through variables for added security.

Advanced fields are optional, but Postman will attempt to generate them automatically if necessary.

• For AWS Region, enter one of the regions (eu-central-3) where your bucket is hosted.

• For Service Name, enter s3. The name of the service that receives the requests.

• For Session Token, leave the field blank. This is only required when temporary security credentials are used.

Path parameters

Bucketstring · min: 3 · max: 63Required

The bucket name.

Example: my-bucket

Keystring · min: 1Required

The key name of the object whose Legal Hold status you want to retrieve.

Query parameters

legal-holdboolean · enumRequiredPossible values:

versionIdstringOptional

The version ID of the object whose Legal Hold status you want to retrieve.

Responses

200

Successful operation

application/xml

400

InvalidRequest

application/xml

403

AccessDenied

application/xml

404

NoSuchBucket, NoSuchKey or NoSuchObjectLockConfiguration

application/xml

get

/{Bucket}/{Key}?legal-hold

HTTPcURLJavaScriptPython

GET /{Bucket}/{Key}?legal-hold?legal-hold=true HTTP/1.1
Host: s3.eu-central-3.ionoscloud.com
Authorization: YOUR_API_KEY
Accept: */*

<?xml version="1.0" encoding="UTF-8"?>
<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Status>ON</Status>
</LegalHold>

PutObjectLegalHold

put

https://s3.eu-central-3.ionoscloud.comhttps://s3.us-central-1.ionoscloud.com

/{Bucket}/{Key}?legal-hold

Applies a Legal Hold configuration to the specified object.

Permissions

You must be the contract owner or an administrator to perform this operation. If not, they can grant you permission to perform the s3:PutObjectLegalHold operation using Bucket Policy.

Authorizations

hmac

AuthorizationstringRequired

IONOS Object Storage API requests are authenticated using the AWS signature. The IONOS Object Storage API authenticates users using a customized HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code). The process of generating the proper Authorization header is somewhat involved. We recommend that you make use of a tool such as Postman.

In the Authorization tab for a request, select AWS Signature from the Type dropdown list. Specify where Postman should append your authorization data using the Add authorization data to drop-down menu.

• If you select Request Headers, Postman populates the Headers tab with Authorization and X-Amz- prefixed fields.

• If you select Request URL, Postman populates the Params tab with authentication details prefixed with X-Amz-.

Note: The parameters listed below contain confidential information. We recommend using variables to keep this data secure while working in a collaborative environment.

• For Access Key, enter your access key directly in the fields or through variables for added security.

• For Secret Key, enter your secret key directly in the fields or through variables for added security.

Advanced fields are optional, but Postman will attempt to generate them automatically if necessary.

• For AWS Region, enter one of the regions (eu-central-3) where your bucket is hosted.

• For Service Name, enter s3. The name of the service that receives the requests.

• For Session Token, leave the field blank. This is only required when temporary security credentials are used.

Path parameters

Bucketstring · min: 3 · max: 63Required

The bucket name.

Example: my-bucket

Keystring · min: 1Required

The key name of the object on which you want to place a Legal Hold.

Query parameters

legal-holdboolean · enumRequiredPossible values:

versionIdstringOptional

The version ID of the object on which you want to place a Legal Hold.

Header parameters

Content-MD5stringOptional

The base64 encoded MD5 digest of the message (without the headers) according to RFC 1864.

Body

application/xml

Responses

200

Successful operation

application/xml

400

InvalidRequest or MalformedXML

application/xml

403

AccessDenied

application/xml

404

NoSuchBucket or NoSuchKey

application/xml

put

/{Bucket}/{Key}?legal-hold

HTTPcURLJavaScriptPython

PUT /{Bucket}/{Key}?legal-hold?legal-hold=true HTTP/1.1
Host: s3.eu-central-3.ionoscloud.com
Authorization: YOUR_API_KEY
Content-Type: application/xml
Accept: */*
Content-Length: 148

"<?xml version="1.0" encoding="UTF-8"?>
<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Status>ON</Status>
</LegalHold>
"

Payload to switch ONPayload to switch OFF

No content