Skip to main content
GET
/
api
/
instance
/
getProxy
/
:instance
Read Proxy
curl --request GET \
  --url https://api.example.com/api/instance/getProxy/: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 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"

​
Success response

200 OK
{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.example.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1"
  }
}
The password field is never returned by this endpoint.

​
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 proxy configurationDatabase 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.

​
Next

Update proxy

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