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

# Verificar S3

> Lê a configuração de armazenamento S3 da instância

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

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/instance/getS3/minha-instancia" \
    -H "token: $Token_Instance"
  ```

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

  ```python Python theme={null}
  import os, requests

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

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

## Resposta de sucesso

<Tabs>
  <Tab title="S3 ativo">
    ```json 200 OK theme={null}
    {
      "success": true,
      "s3": {
        "enabled": true,
        "region": "us-east-1",
        "bucket": "ryzeapi-media",
        "accessKey": "AKIA...",
        "secretKey": null,
        "endpoint": "",
        "pathPrefix": "media/myinstance/"
      }
    }
    ```
  </Tab>

  <Tab title="S3 desabilitado">
    ```json 200 OK theme={null}
    {
      "success": true,
      "s3": {
        "enabled": false,
        "region": null,
        "bucket": null,
        "accessKey": null,
        "secretKey": null,
        "endpoint": null,
        "pathPrefix": null
      }
    }
    ```
  </Tab>
</Tabs>

<Note>
  `secretKey` sai como `null`, o servidor nunca devolve a chave secreta 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>

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

```json theme={null}
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}
```

## Notas

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

## Próximo

<CardGroup cols={2}>
  <Card title="Atualizar S3" icon="pen-to-square" href="/pt/api/instance/s3-update">
    `POST /api/instance/s3/:instance` para alterar.
  </Card>
</CardGroup>