Definir S3

POST

api

instance

:instance

Definir 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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Configura o storage S3 da instância. secretKey é encriptado at-rest e nunca retornado. Para storage compatível com S3 (MinIO, Backblaze, DO Spaces), preencha endpoint com a URL.

Exemplos

AWS S3

Aponta o storage para AWS S3 oficial: bucket ryzeapi-media em us-east-1, com endpoint vazio para usar o domínio padrão da AWS e prefixo media/myinstance/ para isolar os arquivos.

curl -X POST "https://ryzeapi.cloud/api/instance/s3/minha-instancia" \
  -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/minha-instancia", {
  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/minha-instancia",
    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/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

MinIO self-hosted

Mesmo formato do AWS, mas com endpoint apontando para um MinIO interno (https://minio.interno.empresa.com). O mesmo padrão funciona para DigitalOcean Spaces, Backblaze B2 e outros storages compatíveis com S3.

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

await fetch("https://ryzeapi.cloud/api/instance/s3/minha-instancia", {
  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.interno.empresa.com",
    accessKey:  "minioadmin",
    secretKey:  "minioadmin",
    pathPrefix: "ryzeapi/"
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/s3/minha-instancia",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "enabled":    True,
        "region":     "us-east-1",
        "bucket":     "whatsapp",
        "endpoint":   "https://minio.interno.empresa.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.interno.empresa.com",
        "accessKey":  "minioadmin",
        "secretKey":  "minioadmin",
        "pathPrefix": "ryzeapi/"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/s3/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Desabilitar

Envia apenas enabled: false para desativar o storage e apagar as credenciais do banco. Para reabilitar depois é necessário reenviar todos os campos novamente.

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

await fetch("https://ryzeapi.cloud/api/instance/s3/minha-instancia", {
  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/minha-instancia",
    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/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Resposta de sucesso

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 não aparece na resposta, o servidor nunca devolve a chave em plaintext.

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json.

Request body

boolean

obrigatório

Ativa/desativa o S3 da instância. false zera todos os campos.

string

Região (ex.: us-east-1).

string

Nome do bucket (deve existir, não há criação).

string

Access Key ID.

string

Secret Access Key. Encriptada at-rest.

string

Endpoint custom (MinIO, DO Spaces, Backblaze). Vazio para AWS S3 oficial.

string

Prefixo de path (ex.: media/myinstance/).

Notas

Não há teste de credenciais. O endpoint salva a config sem validar se o bucket existe ou se as credenciais funcionam, o erro só aparece quando o próximo upload de mídia tentar autenticar (visível nos logs do servidor).

Desabilitar (enabled=false) apaga as credenciais do banco. Para reabilitar depois, é necessário reenviar todos os campos.

Erros

HTTP	`error.message`	Quando
400	`Invalid request body`	JSON malformado.
401	`Invalid token`	Token ausente ou inválido.
404	`Instance not found`	Nome não existe.
429	`Rate limit exceeded. Try again later.`	Mais de 100 req/min.
500	`Failed to update S3 configuration`	Erro de banco.

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

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

AWS S3

MinIO self-hosted

Desabilitar

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​AWS S3

​MinIO self-hosted

​Desabilitar

​Resposta de sucesso

​Path parameters

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

AWS S3

MinIO self-hosted

Desabilitar

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Erros