Read Proxy

GET

api

instance

getProxy

:instance

Read Proxy

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

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

fetch('https://api.example.com/api/instance/getProxy/: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 only the individual proxy of the instance (does not include fallback to the deploy global proxy). If the instance has no proxy of its own, returns enabled: false with the other fields empty. The password is not returned.

Example

Performs a GET on the instance path and returns the proxy object with the active configuration (without including the password). If the instance has no individual proxy, it comes with enabled: false and the other fields null.

curl -X GET "https://ryzeapi.cloud/api/instance/getProxy/my-instance" \
  -H "token: $Token_Instance"

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

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/instance/getProxy/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/getProxy/my-instance", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Success response

With proxy
Without proxy

200 OK

{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.example.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1"
  }
}

200 OK

{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": false,
    "host": null,
    "port": null,
    "protocol": null,
    "username": null
  }
}

The password field is never returned by this endpoint.

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 proxy configuration`	Database error.

{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

Notes

This endpoint does not expose the deploy global proxy intentionally, you only see what you configured for this instance.

Update proxy

POST /api/instance/proxy/: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 proxy

​Description

​Example

​Success response

​Path parameters

​Headers

​Errors

​Notes

​Next

Update proxy

Description

Example

Success response

Path parameters

Headers

Errors

Notes

Next