> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Definir S3

> Define credenciais e bucket S3 para armazenar mídia da instância

**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.

<CodeGroup>
  ```bash cURL theme={null}
  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/"
    }'
  ```

  ```javascript JavaScript theme={null}
  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/"
    })
  });
  ```

  ```python Python theme={null}
  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/"
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  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/"
    }'
  ```

  ```javascript JavaScript theme={null}
  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/"
    })
  });
  ```

  ```python Python theme={null}
  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/"
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/instance/s3/minha-instancia" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{"enabled":false}'
  ```

  ```javascript JavaScript theme={null}
  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 })
  });
  ```

  ```python Python theme={null}
  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}
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

## Resposta de sucesso

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

<Note>
  `secretKey` **não** aparece na resposta, o servidor nunca devolve a chave em plaintext.
</Note>

## Path parameters

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  TokenAccount ou TokenInstance.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`.
</ParamField>

## Request body

<ParamField body="enabled" type="boolean" required>
  Ativa/desativa o S3 da instância. `false` zera todos os campos.
</ParamField>

<ParamField body="region" type="string">
  Região (ex.: `us-east-1`).
</ParamField>

<ParamField body="bucket" type="string">
  Nome do bucket (deve existir, não há criação).
</ParamField>

<ParamField body="accessKey" type="string">
  Access Key ID.
</ParamField>

<ParamField body="secretKey" type="string">
  Secret Access Key. Encriptada at-rest.
</ParamField>

<ParamField body="endpoint" type="string">
  Endpoint custom (MinIO, DO Spaces, Backblaze). Vazio para AWS S3 oficial.
</ParamField>

<ParamField body="pathPrefix" type="string">
  Prefixo de path (ex.: `media/myinstance/`).
</ParamField>

## Notas

<Warning>
  **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).
</Warning>

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

## 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.             |

```json theme={null}
{
  "success": false,
  "error": {
    "message": "Failed to update S3 configuration"
  }
}
```