Get a server

GEThttps://api.vpsbg.eu/v1/servers/{id}

This endpoint will return data regarding your server.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

string

required

Body Params text/plain

Request samples

Responses

Returns the server model(200)

Returns the server model

HTTP Code: 200

Content Type : JSONapplication/json

This model represent a VPSBG Server.

integer

required

Internal ID of the server.

Example:

2864

hostname

string

required

Actual hostname installed on the server.

Example:

ubuntu-2gb

billing_cycle

integer

required

Example:

plan

object

required

integer

optional

Example:

104

type

string

optional

The VDS servers have dedicated CPU cores. Cloud VPS is using shared CPU power.

Example:

cloud-vps

key

string

optional

name

string

optional

Example:

cloud-vps-2gb

vcpus

integer

optional

CPU cores limit. Dedicated, if it is a VDS product.

Example:

memory

integer

optional

RAM of the server.

Example:

disk

integer

optional

NVMe disk size limit in gigabytes.

Example:

bandwidth

integer

optional

Traffic limit in terabytes.

Example:

minimum_billing_cycle

integer

optional

The minimum billing period for which this plan can be purchased.

Example:

plan_with_more_disk

integer

optional

The same plan but with more disk (usually 2x).

plan_with_more_memory

integer

optional

The same plan but with more RAM (usually 2x).

available

boolean

optional

Whether in stock or not.

price

number

optional

Monthly price without VAT adjustments.

Example:

100

price_with_vat

number

optional

Monthly prices adjusted for your VAT when applicable; use a promo code when ordering servers for discounts, or one may be automatically applied during promotional periods for your billing cycle.

Example:

120

status

string

required

This is the billing status of the server. It does not represent the technical status of the server - running, stopped, etc.

Examples:

active processing suspended terminated

locked

boolean

required

The server might be locked in some scenarios like creating a snapshot, backup or other operation.

created_at

string

required

Example:

2024-08-29T14:21:54.000000Z

expiry_at

string

required

Example:

2024-10-27T11:03:10.000000Z

potential_expiry_at

string

required

Accounts for unpaid or processing renew Orders.

Example:

2024-11-27T11:03:10.000000Z

auto_renew

boolean

required

If set to true, the server will be renewed using funds from your account balance or saved credit/credit cards.

server_image

object

required

integer

required

Example:

name

string

required

Example:

Ubuntu 22.04

group

object

required

ip_addresses

object

required

integer

required

Example:

417

ip_address

string

required

The IP address.

Example:

87.120.37.46

prefix

integer

required

Examples:

3264

version

integer

required

Example:

type

string

required

Example:

public

main

boolean

required

ddos_protected

boolean

required

Whether the IP is DDoS protected or not.

floating_ip

boolean

required

Whether or not this IP is sold as a Floating IP.

ptr

object | null

optional

assigned_on

string

required

Datetime when the IP address was assigned to your account.

addons

array [object {2}]

required

name

string

optional

Example:

backups

quantity

integer

optional

Example:

Not configured

Last modified: 3 months ago