Skip to main content
GET
/
servers
/
{server}
Get server
curl --request GET \
  --url https://rdp.sh/api/v1/servers/{server} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "hostname": "<string>",
  "node": "<string>",
  "rdns": "<string>",
  "distro": "<string>",
  "status": "<string>",
  "plan_id": 123,
  "created_at": "<string>",
  "ip_address": "<string>",
  "expiry_date": "<string>",
  "username": "<string>",
  "password": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
server
string
required

Response

200 - application/json

The request was successful, and the server has returned the requested resource in the response body.

Detailed server view, including login credentials.

​
id
string
Example:

"1"

​
hostname
string | null
Example:

"my-server"

​
node
string
Example:

"001-ams"

​
rdns
string
Example:

"1.3.3.7.powered.by.rdp.sh."

​
distro
string
Examples:

"Windows Server 2025"

"Debian 12"

"Debian 11"

"Ubuntu 24.04 LTS"

​
status
string
Example:

"stopped"

​
plan_id
integer
Example:

1

​
created_at
string
Example:

"2023-12-23T01:06:46.000Z"

​
ip_address
string
Example:

"1.3.3.7"

​
expiry_date
string
Example:

"2024-11-20T05:20:00.000Z"

​
username
string

Login username for the server. Returned values:

  • Administrator for Windows servers
  • root for selected Linux distros (Debian, Ubuntu, CentOS, etc.)
  • vshell for managed Linux distros
Examples:

"Administrator"

"root"

"vshell"

​
password
string | null

Decrypted credential for the server. For Windows this is the RDP password; for Linux it is the SSH password for the user returned in username. Only available to the server owner.

Example:

"s3cret-p4ssw0rd"