Skip to main content
GET
/
api
/
instance
/
getS3
/
:instance
Read S3
curl --request GET \
  --url https://api.example.com/api/instance/getS3/:instance \
  --header 'token: <token>'
Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Returns the individual S3 configuration of the instance. The secretKey is never returned.

​
Example

Performs a GET on the instance path and returns the s3 object with the storage configuration. The secretKey field is always returned as null for security. 
curl -X GET "https://ryzeapi.cloud/api/instance/getS3/my-instance" \
  -H "token: $Token_Instance"

​
Success response

200 OK
{
  "success": true,
  "s3": {
    "enabled": true,
    "region": "us-east-1",
    "bucket": "ryzeapi-media",
    "accessKey": "AKIA...",
    "secretKey": null,
    "endpoint": "",
    "pathPrefix": "media/myinstance/"
  }
}
secretKey is returned as null, the server never returns the secret key in plaintext.

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Errors

HTTPerror.messageWhen
401Invalid tokenToken missing or invalid.
404Instance not foundName does not exist.
429Rate limit exceeded. Try again later.More than 100 req/min.
500Failed to get S3 configurationDatabase error.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Notes

An empty ("") or null endpoint indicates official AWS S3; for MinIO, DigitalOcean Spaces, or Backblaze, this field stores the full endpoint URL.

​
Next

Update S3

POST /api/instance/s3/:instance to change.