Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
VMs

Get a VM's embedded Telegram link

GET
/v1/vms/{id}/telegram-link
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/vms/string/telegram-link"
{
  "present": true,
  "telegramUserId": 0,
  "telegramUsername": "string",
  "linkingCode": "string",
  "linkedAt": "string",
  "createdAt": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl vms telegram-link get <id>