Verificar S3

GET

api

instance

getS3

:instance

Verificar S3

curl --request GET \
  --url https://api.example.com/api/instance/getS3/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

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

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Retorna a configuração S3 individual da instância. O secretKey nunca é retornado.

Exemplo

Faz GET no path da instância e devolve o objeto s3 com a configuração de armazenamento. O campo secretKey sai sempre null por segurança.

curl -X GET "https://ryzeapi.cloud/api/instance/getS3/minha-instancia" \
  -H "token: $Token_Instance"

await fetch("https://ryzeapi.cloud/api/instance/getS3/minha-instancia", {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/instance/getS3/minha-instancia",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/instance/getS3/minha-instancia", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Resposta de sucesso

S3 ativo
S3 desabilitado

200 OK

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

200 OK

{
  "success": true,
  "s3": {
    "enabled": false,
    "region": null,
    "bucket": null,
    "accessKey": null,
    "secretKey": null,
    "endpoint": null,
    "pathPrefix": null
  }
}

secretKey sai como null, o servidor nunca devolve a chave secreta em plaintext.

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Erros

HTTP	`error.message`	Quando
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 get S3 configuration`	Erro de banco.

{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

Notas

endpoint em branco ("") ou null indica AWS S3 oficial; para MinIO, DigitalOcean Spaces ou Backblaze, esse campo guarda a URL completa do endpoint.

Atualizar S3

POST /api/instance/s3/:instance para alterar.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplo

Resposta de sucesso

Path parameters

Headers

Erros

Notas

Próximo

Atualizar S3

​Descrição

​Exemplo

​Resposta de sucesso

​Path parameters

​Headers

​Erros

​Notas

​Próximo

Atualizar S3

Descrição

Exemplo

Resposta de sucesso

Path parameters

Headers

Erros

Notas

Próximo