Skip to main content

Update Bucket

PUT 
/api/v2/instance/:instanceId/minio

Update Bucket

Request​

Path Parameters

    instanceId stringrequired

    ID of the instance.

Body

required

  • bucketName (String): Bucket name. It is mandatory and must be a string

  • enabled (Boolean, optional): Enable or disable your bucket

  • accessID (String): Access ID. Mandatory and must be a string

    • When the enabled variable is set to true, the API will automatically detect and store every new media message it receives in the designated bucket.

  • secretKey (String): Secret key. Mandatory and must be a string

  • useSSL (Boolean, optional): Defines whether SSL will be used. The default is false

  • port (Number, optional): Port for the connection. The default is 9000. Validation to ensure it is an integer

  • region (String, optional): Region for storage configuration. Subject to conditional validation]

  • sslConf (Object, optional):

    • certificate (String, optional): Certificate for the domain. The presence of this variable is conditionally validated
    • privateKey (String, optional): Private key for the domain. Also subject to conditional validation.

Bucket Name Rules​

If the bucket informed in the bucketName variable does not exist, a new bucket will be created automatically.

  • Bucket names must be between 3 (min) and 63 (max) characters long
  • Bucket names can consist only of lowercase letters, numbers, dots (.), and hyphens (-)
  • Bucket names must not contain two adjacent periods, or a period adjacent to a hyphen
  • Bucket names must not be formatted as an IP address (for example, 192.168.5.4)
  • Bucket names must not start with the prefix xn--
  • Bucket names must not end with the suffix -s3alias. This suffix is reserved for access point alias names
  • Bucket names must be unique within a partition
    enabled Enabled

    Default value: true

    Enable or disable your bucket

    endPoint EndPointrequired
    useSSL Use SSL

    Default value: false

    port Port

    Default value: 9000

    sslConf object
    certificate Certificate

    Certificate for your domain

    privateKey Private Key

    Private key for your domain

    bucketName Bucket Name
    accessId Access ID
    secretKey Secret Keyrequired

Responses​

Success - status: 201

Schema
    bucketId stringrequired
    enabled booleanrequired
    bucketName stringrequired
    accessId stringrequired
    secretKey stringrequired
    endPoint stringrequired
    region stringrequired
    port numberrequired
    useSSL booleanrequired
    ssl object
    certificate Certificate

    Certificate for your domain

    privateKey Private Key

    Private key for your domain

    instanceInstanceId stringrequired
Loading...