{"description":"api_v1_s3_config","type":"object","properties":{"enabled":{"description":"When enabled, allows the cluster to make S3 connections.","type":"boolean"},"base_path":{"description":"The default bucket directory prefix for all S3 buckets created without an explicitly specified path, for example, by using the CreateBucket API action. You must specify this directory as an absolute path.","type":"string"},"multipart_upload_expiry_interval":{"description":"The time period during which the system permits a multipart upload to remain unmodified. When this time period elapses, the system considers the multipart upload stale and cleans it up automatically. Specify the time period in the <quantity><units> format (for example, 5days). Quantity must be a positive integer less than 100 and units must be one of the following: months, weeks, days, or hours. To disable automatic multipart upload cleanup, specify never for quantity and do not specify any units.","type":"string"},"secure":{"description":"If you specify true, the S3 server accepts only HTTP connections. By default, the S3 server accepts only HTTP connections.","type":"boolean"}}}
PATCH
Modify the current S3 server settings.
Parameters
This resource has no parameters.
Request
Schema
{"description":"api_v1_s3_config_patch","type":"object","properties":{"enabled":{"description":"When enabled, allows the cluster to make S3 connections.","type":"boolean"},"base_path":{"description":"The default bucket directory prefix for all S3 buckets created without an explicitly specified path, for example, by using the CreateBucket API action. You must specify this directory as an absolute path.","type":"string"},"multipart_upload_expiry_interval":{"description":"The time period during which the system permits a multipart upload to remain unmodified. When this time period elapses, the system considers the multipart upload stale and cleans it up automatically. Specify the time period in the <quantity><units> format (for example, 5days). Quantity must be a positive integer less than 100 and units must be one of the following: months, weeks, days, or hours. To disable automatic multipart upload cleanup, specify never for quantity and do not specify any units.","type":"string"},"secure":{"description":"If you specify true, the S3 server accepts only HTTP connections. By default, the S3 server accepts only HTTP connections.","type":"boolean"}}}
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"api_v1_s3_config","type":"object","properties":{"enabled":{"description":"When enabled, allows the cluster to make S3 connections.","type":"boolean"},"base_path":{"description":"The default bucket directory prefix for all S3 buckets created without an explicitly specified path, for example, by using the CreateBucket API action. You must specify this directory as an absolute path.","type":"string"},"multipart_upload_expiry_interval":{"description":"The time period during which the system permits a multipart upload to remain unmodified. When this time period elapses, the system considers the multipart upload stale and cleans it up automatically. Specify the time period in the <quantity><units> format (for example, 5days). Quantity must be a positive integer less than 100 and units must be one of the following: months, weeks, days, or hours. To disable automatic multipart upload cleanup, specify never for quantity and do not specify any units.","type":"string"},"secure":{"description":"If you specify true, the S3 server accepts only HTTP connections. By default, the S3 server accepts only HTTP connections.","type":"boolean"}}}
