Update S3

POST

api

instance

:instance

Update S3

curl --request POST \
  --url https://api.example.com/api/instance/s3/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "enabled": true,
  "region": "<string>",
  "bucket": "<string>",
  "accessKey": "<string>",
  "secretKey": "<string>",
  "endpoint": "<string>",
  "pathPrefix": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    enabled: true,
    region: '<string>',
    bucket: '<string>',
    accessKey: '<string>',
    secretKey: '<string>',
    endpoint: '<string>',
    pathPrefix: '<string>'
  })
};

fetch('https://api.example.com/api/instance/s3/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/instance/s3/:instance"

payload = {
    "enabled": True,
    "region": "<string>",
    "bucket": "<string>",
    "accessKey": "<string>",
    "secretKey": "<string>",
    "endpoint": "<string>",
    "pathPrefix": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

Description

Configures the S3 storage of the instance. secretKey is encrypted at-rest and never returned. For S3-compatible storage (MinIO, Backblaze, DO Spaces), fill endpoint with the URL.

Examples

AWS S3

Points storage to official AWS S3: bucket ryzeapi-media in us-east-1, with endpoint empty to use AWS’s default domain and prefix media/myinstance/ to isolate the files.

curl -X POST "https://ryzeapi.cloud/api/instance/s3/my-instance" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "region": "us-east-1",
    "bucket": "ryzeapi-media",
    "accessKey": "AKIA...",
    "secretKey": "secret-redacted",
    "endpoint": "",
    "pathPrefix": "media/myinstance/"
  }'

await fetch("https://ryzeapi.cloud/api/instance/s3/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    enabled:    true,
    region:     "us-east-1",
    bucket:     "ryzeapi-media",
    accessKey:  "AKIA...",
    secretKey:  "secret-redacted",
    endpoint:   "",
    pathPrefix: "media/myinstance/"
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/s3/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "enabled":    True,
        "region":     "us-east-1",
        "bucket":     "ryzeapi-media",
        "accessKey":  "AKIA...",
        "secretKey":  "secret-redacted",
        "endpoint":   "",
        "pathPrefix": "media/myinstance/"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "enabled":    true,
        "region":     "us-east-1",
        "bucket":     "ryzeapi-media",
        "accessKey":  "AKIA...",
        "secretKey":  "secret-redacted",
        "endpoint":   "",
        "pathPrefix": "media/myinstance/"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/s3/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Self-hosted MinIO

Same format as AWS, but with endpoint pointing to an internal MinIO (https://minio.internal.company.com). The same pattern works for DigitalOcean Spaces, Backblaze B2, and other S3-compatible storage.

curl -X POST "https://ryzeapi.cloud/api/instance/s3/my-instance" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "region": "us-east-1",
    "bucket": "whatsapp",
    "endpoint": "https://minio.internal.company.com",
    "accessKey": "minioadmin",
    "secretKey": "minioadmin",
    "pathPrefix": "ryzeapi/"
  }'

await fetch("https://ryzeapi.cloud/api/instance/s3/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    enabled:    true,
    region:     "us-east-1",
    bucket:     "whatsapp",
    endpoint:   "https://minio.internal.company.com",
    accessKey:  "minioadmin",
    secretKey:  "minioadmin",
    pathPrefix: "ryzeapi/"
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/s3/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "enabled":    True,
        "region":     "us-east-1",
        "bucket":     "whatsapp",
        "endpoint":   "https://minio.internal.company.com",
        "accessKey":  "minioadmin",
        "secretKey":  "minioadmin",
        "pathPrefix": "ryzeapi/"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "enabled":    true,
        "region":     "us-east-1",
        "bucket":     "whatsapp",
        "endpoint":   "https://minio.internal.company.com",
        "accessKey":  "minioadmin",
        "secretKey":  "minioadmin",
        "pathPrefix": "ryzeapi/"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/s3/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Disable

Sends only enabled: false to disable the storage and delete the credentials from the database. To re-enable later, all fields must be sent again.

curl -X POST "https://ryzeapi.cloud/api/instance/s3/my-instance" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

await fetch("https://ryzeapi.cloud/api/instance/s3/my-instance", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ enabled: false })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/s3/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"enabled": False}
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"enabled":false}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/s3/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Success response

200 OK

{
  "success": true,
  "message": "S3 configuration updated",
  "s3": {
    "enabled": true,
    "region": "us-east-1",
    "bucket": "ryzeapi-media",
    "accessKey": "AKIA...",
    "endpoint": "",
    "pathPrefix": "media/myinstance/"
  }
}

secretKey does not appear in the response, the server never returns the key in plaintext.

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json.

Request body

boolean

required

Enables/disables the instance S3. false clears all fields.

string

Region (e.g., us-east-1).

string

Bucket name (must exist; no creation is performed).

string

Access Key ID.

string

Secret Access Key. Encrypted at-rest.

string

Custom endpoint (MinIO, DO Spaces, Backblaze). Empty for official AWS S3.

string

Path prefix (e.g., media/myinstance/).

Notes

There is no credential testing. The endpoint saves the config without validating whether the bucket exists or whether the credentials work, the error only appears when the next media upload tries to authenticate (visible in the server logs).

Disabling (enabled=false) deletes the credentials from the database. To re-enable later, all fields must be sent again.

Errors

HTTP	`error.message`	When
400	`Invalid request body`	Malformed JSON.
401	`Invalid token`	Token missing or invalid.
404	`Instance not found`	Name does not exist.
429	`Rate limit exceeded. Try again later.`	More than 100 req/min.
500	`Failed to update S3 configuration`	Database error.

{
  "success": false,
  "error": {
    "message": "Failed to update S3 configuration"
  }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

AWS S3

Self-hosted MinIO

Disable

Success response

Path parameters

Headers

Request body

Notes

Errors

​Description

​Examples

​AWS S3

​Self-hosted MinIO

​Disable

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

Description

Examples

AWS S3

Self-hosted MinIO

Disable

Success response

Path parameters

Headers

Request body

Notes

Errors