Saltar al contenido principal
GET
/
api
/
instance
/
getS3
/
:instance
Leer S3
curl --request GET \
  --url https://api.example.com/api/instance/getS3/:instance \
  --header 'token: <token>'
Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Devuelve la configuración individual de S3 de la instancia. La secretKey nunca se devuelve.

​
Ejemplo

Realiza un GET en la ruta de la instancia y devuelve el objeto s3 con la configuración de almacenamiento. El campo secretKey siempre se devuelve como null por seguridad. 
curl -X GET "https://ryzeapi.cloud/api/instance/getS3/my-instance" \
  -H "token: $Token_Instance"

​
Respuesta exitosa

200 OK
{
  "success": true,
  "s3": {
    "enabled": true,
    "region": "us-east-1",
    "bucket": "ryzeapi-media",
    "accessKey": "AKIA...",
    "secretKey": null,
    "endpoint": "",
    "pathPrefix": "media/myinstance/"
  }
}
secretKey se devuelve como null, el servidor nunca devuelve la secret key en texto plano.

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Errores

HTTPerror.messageCuándo
401Invalid tokenToken faltante o inválido.
404Instance not foundNombre no existe.
429Rate limit exceeded. Try again later.Más de 100 req/min.
500Failed to get S3 configurationError de base de datos.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Notas

Un endpoint vacío ("") o null indica AWS S3 oficial; para MinIO, DigitalOcean Spaces o Backblaze, este campo almacena la URL completa del endpoint.

​
Siguiente

Actualizar S3

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