Read S3

GET

api

instance

getS3

:instance

Read S3

curl --request GET \
  --url https://api.example.com/api/instance/getS3/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/instance/getS3/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch("https://ryzeapi.cloud/api/instance/getS3/my-instance", {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

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

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/instance/getS3/my-instance", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Success response

S3 active
S3 disabled

200 OK

{
  "success": true,
  "s3": {
    "enabled": true,
    "region": "us-east-1",
    "bucket": "ryzeapi-media",
    "accessKey": "AKIA...",
    "secretKey": null,
    "endpoint": "",
    "pathPrefix": "media/myinstance/"
  }
}

200 OK

{
  "success": true,
  "s3": {
    "enabled": false,
    "region": null,
    "bucket": null,
    "accessKey": null,
    "secretKey": null,
    "endpoint": null,
    "pathPrefix": null
  }
}

secretKey is returned as null, the server never returns the secret key in plaintext.

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Errors

HTTP	`error.message`	When
401	`Invalid token`	Token missing or invalid.
404	`Instance not found`	Name does not exist.
429	`Rate limit exceeded. Try again later.`	More than 100 req/min.
500	`Failed to get S3 configuration`	Database 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.

Update S3

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

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Example

Success response

Path parameters

Headers

Errors

Notes

Next

Update S3

​Description

​Example

​Success response

​Path parameters

​Headers

​Errors

​Notes

​Next

Update S3

Description

Example

Success response

Path parameters

Headers

Errors

Notes

Next