3 min


Using Minio SDK

First install the SDK:

pip3 install minio

Then instantiate a client object using garage root domain, api key and secret:

import minio

client = minio.Minio(
  # Force the region, this is specific to garage

Then use all the standard S3 endpoints as implemented by the Minio SDK:

# List buckets

# Put an object containing 'content' to /path in bucket named 'bucket':
content = b"content"

# Read the object back and check contents
data = client.get_object("bucket", "path").read()
assert data == content

For further documentation, see the Minio SDK Reference

Using Amazon boto3

Coming soon

See the official documentation:


Coming soon

Admin API

You need at least Python 3.6, pip, and setuptools. Because the python package is in a subfolder, the command is a bit more complicated than usual:

pip3 install --user 'git+'

Now, let imagine you have a fresh Garage instance running on localhost, with the admin API configured on port 3903 with the bearer s3cr3t:

import garage_admin_sdk
from garage_admin_sdk.apis import *
from garage_admin_sdk.models import *

configuration = garage_admin_sdk.Configuration(
  host = "http://localhost:3903/v0",
  access_token = "s3cr3t"

# Init APIs
api = garage_admin_sdk.ApiClient(configuration)
nodes, layout, keys, buckets = NodesApi(api), LayoutApi(api), KeyApi(api), BucketApi(api)

# Display some info on the node
status = nodes.get_nodes()
print(f"running garage {status.garage_version}, node_id {status.node}")

# Change layout of this node
current = layout.get_layout()
  status.node: NodeClusterInfo(
    zone = "dc1",
    capacity = 1,
    tags = [ "dev" ],
  version = current.version + 1

# Create key, allow it to create buckets
kinfo = keys.add_key(AddKeyRequest(name="openapi"))

allow_create = UpdateKeyRequestAllow(create_bucket=True)
keys.update_key(kinfo.access_key_id, UpdateKeyRequest(allow=allow_create))

# Create a bucket, allow key, set quotas
binfo = buckets.create_bucket(CreateBucketRequest(global_alias="documentation"))
binfo = buckets.allow_bucket_key(AllowBucketKeyRequest(,
  permissions=AllowBucketKeyRequestPermissions(read=True, write=True, owner=True),
binfo = buckets.update_bucket(, UpdateBucketRequest(

# Display key
cluster ready
key id is {kinfo.access_key_id}
secret key is {kinfo.secret_access_key}
bucket {binfo.global_aliases[0]} contains {binfo.objects}/{binfo.quotas.max_objects} objects

This example is named in the example folder. Other python examples are also available.

See also: