Bucket Settings

Configure settings for a Stook Bucket.

Update bucket settings

patch

Changes one or more settings of a bucket. Send only the settings you want to change. Changes are checked before they are applied, and applied to the bucket before they are saved. If a change is refused, nothing is saved and an error is returned.

Path parameters

organization_uuidstringRequired

Unique identifier for the organization.

bucket_uuidstringRequired

Unique identifier for the storage bucket.

Body

Send only the settings you want to change. Settings left out are not changed. null is not accepted.

is_ip_restrictionbooleanOptional

Turns IP restriction on or off. Requests made with the master key are not restricted.

restriction_typestring · enumOptional

What happens to addresses that are not on the list. deny: allow only the addresses in allow_ip_list. allow: block the addresses in deny_ip_list.

Possible values:

status_cors_headerstring · enumOptional

Turns CORS on or off. dynamic is a legacy value that behaves like on with cors_domains set to *.

Possible values:

cors_domainsstring[] · max: 100Optional

Origins allowed to send cross-origin requests, such as https://example.com or *.example.com. * allows any origin and takes precedence over other entries.

is_rate_limitbooleanOptional

Turns the rate limit on or off. When on, at least one of max_read_ops and max_write_ops must be above 0.

versioningstring · enumOptional

Versioning mode. Once enabled, it cannot return to unversioned; use suspended instead.

Possible values:

object_lock_enabledbooleanOptional

Turns object lock on, in governance mode. Requires versioning to be enabled. Cannot be switched off once enabled.

object_lock_daysinteger · min: 1 · max: 365Optional

Retention period in days for objects written from now on.

mfa_deletebooleanOptional

Turns MFA Delete on or off. Requires versioning to be enabled. Changing it requires mfa_credential_uuid and mfa_code.

block_public_accessbooleanOptional

Prevents the bucket from being made public. Cannot be turned on while the bucket is public.

is_quotabooleanOptional

Turns the quota on or off. When on, quota_size is required.

quota_sizeinteger · min: 1 · max: 9007199254740991Optional

Maximum storage size of the bucket, in bytes. Changes may take up to 10 minutes to take effect.

sse_enabledbooleanOptional

Encrypts objects uploaded from now on with AES-256. Existing objects are not changed.

mfa_credential_uuidstringOptional

Access key that confirms an MFA Delete change. Must have an authenticator and the s3:PutBucketVersioning permission. Not stored.

mfa_codestringOptional

Current six-digit code from the access key's authenticator. Not stored.

Pattern: ^[0-9]{6}$

Responses

200

The settings were applied and saved.

application/json

statusbooleanOptional

Indicates whether the request succeeded.

400

The change is not allowed in the bucket's current state.

application/json

403

The resource was not found in this organization, or the request is not authorized.

application/json

409

A sent setting is not available for this bucket.

application/json

422

Validation error

application/json

502

The storage backend refused the change. Nothing was saved.

application/json

patch/api/v2/stook/{organization_uuid}/bucket/{bucket_uuid}/settings

PATCH /api/v2/stook/{organization_uuid}/bucket/{bucket_uuid}/settings HTTP/1.1
Host: cloud.medianova.com
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "is_rate_limit": true,
  "rate_limit": {
    "max_read_ops": 5000,
    "max_write_ops": 500
  }
}

{
  "status": true,
  "data": {
    "bucket_uuid": "text",
    "is_ip_restriction": true,
    "restriction_type": "deny",
    "ip_list": {
      "allow_ip_list": [
        "text"
      ],
      "deny_ip_list": [
        "text"
      ]
    },
    "status_cors_header": "on",
    "cors_domains": [
      "text"
    ],
    "is_rate_limit": true,
    "rate_limit": {
      "max_read_ops": 1,
      "max_write_ops": 1
    },
    "versioning": "unversioned",
    "object_lock_enabled": true,
    "object_lock_days": null,
    "mfa_delete": true,
    "block_public_access": true,
    "is_quota": true,
    "quota_size": null,
    "sse_enabled": true,
    "notifications": [
      {
        "id": "text",
        "destination_uuid": "text",
        "events": [
          "s3:ObjectCreated:*"
        ],
        "prefix": "text",
        "suffix": "text",
        "topic_arn": "text"
      }
    ]
  }
}