Pular para o conteúdo principal
GET
/
api
/
instance
/
getS3
/
:instance
Verificar S3
curl --request GET \
  --url https://api.example.com/api/instance/getS3/:instance \
  --header 'token: <token>'

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.

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"

​
Resposta de sucesso

200 OK
{
  "success": true,
  "s3": {
    "enabled": true,
    "region": "us-east-1",
    "bucket": "ryzeapi-media",
    "accessKey": "AKIA...",
    "secretKey": null,
    "endpoint": "",
    "pathPrefix": "media/myinstance/"
  }
}
secretKey sai como null, o servidor nunca devolve a chave secreta em plaintext.

​
Path parameters

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Erros

HTTPerror.messageQuando
401Invalid tokenToken ausente ou inválido.
404Instance not foundNome não existe.
429Rate limit exceeded. Try again later.Mais de 100 req/min.
500Failed to get S3 configurationErro 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.

​
Próximo

Atualizar S3

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