Get the device's self-rent tunnel

This endpoint requires authentication. Include your API key in the X-API-KEY header with every request.

Protocol availability

You can create a self-rent tunnel through the API, but its protocol configs are managed in the Hoster dashboard only. The default credential is static and covers Shadowsocks, which must be set up from the dashboard. WireGuard and OpenVPN are not available through the API; download their configs from the dashboard to use them. For now, each device supports a single protocol config: Shadowsocks, WireGuard, or OpenVPN.

GET/hoster/v1/devices/{id}/self-rent/tunnel

The device's self-rent tunnel: connection details and its credentials (every login on the tunnel, including disabled ones). 404 when the hoster has no live rental for the device.

Path Parameters

Name	Type	Required	Description
id	string	Required

Example Request

curl -X GET "https://api.proxied.com/hoster/v1/devices/68fb9f95c5c7c56bcf24d60f/self-rent/tunnel" \
  -H "X-API-KEY: <api-key>"

200 Response

{
  "success": true,
  "data": {
    "tunnelId": "68fb9f95c5c7c56bcf24d60f",
    "status": "enabled",
    "host": "proxy-prod-1a.proxied.com",
    "socks5Port": "18005",
    "httpsPort": "38005",
    "transparentSocks5Port": "1081",
    "uptimeStatus": "up",
    "credentials": [
      {
        "credentialId": "68fb9f95c5c7c56bcf24d60f",
        "username": "hoster_user",
        "password": "p4ssw0rd-9f2a",
        "label": "Primary",
        "status": "active",
        "createdAt": "2024-03-15T10:30:00.000Z",
        "updatedAt": "2024-03-15T10:30:00.000Z"
      }
    ]
  }
}

Error Responses

Error shape

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "readable message"
  }
}

Status	Code	Description
400	VALIDATION_ERROR	Validation failed.
401	MISSING_API_KEY	Missing API key.
403	INVALID_API_KEY	Invalid key or suspended account.
403	HOSTER_BANNED	Invalid key or suspended account.
404	SELF_RENT_TUNNEL_NOT_FOUND	No active self-rent tunnel for this device.
500	INTERNAL_ERROR	Internal error.