Change Primary IP - VPSBG's dev hub

This endpoint changes the primary IP address of a virtual server. The new IP address replaces the current primary IP assigned to the main network interface.
🔄 This action triggers an automatic server reboot to apply the changes.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

integer

required

Header Params

string

required

Default:

application/json

Body Params application/json

ip_id

integer

required

ID of the IP that you would like to place as main.

Example:

33112

Example

{
    "ip_id": 33112
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

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 | null

optional

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

plan_with_more_memory

integer | null

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

running

boolean | null

optional

virtualization

string

required

Example:

kvm

promo_code

string | null

optional

Latest used promo code.

renew_amount

number

required

The amount needed to renew your server for the current period.

renew_amount_with_vat

number

required

Renew amount with vat if applicable.

locked

boolean

required

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

locked_at

string | null

optional

lock_reason

string | null

optional

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.

show_smtp_unblock_form

boolean

required

server_image

object

required

integer

required

Example:

name

string

required

Example:

Ubuntu 22.04

group

object

required

ip_addresses

array[object (IP address) {10}]

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

optional

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 {8}] | null

optional

integer

required

name

string

required

Default:

100mbps-unmetered

Example:

100mbps-unmetered

status

string

required

Default:

active

Examples:

activesuspendedcancelled

quantity

integer

required

Default:

Example:

amount

number

required

Default:

Example:

amount_with_vat

number

required

Default:

Example:

created_at

string

required

Default:

2025-01-16 14:29:56

Example:

2025-01-16 14:29:56

ended_at

string

required

cancel_request

optional

Any of

Cancel Request

null

integer

required

Example:

now

integer

required

Canceled now or at the end of the billing cycle.

Example:

reason

string

optional

Reason given by the user for the cancelation.

created_at

string

required

Date of creation.

settings

object

required

renew_enabled

boolean

required

Default:

true

snapshots_enabled

boolean

required

Default:

true

root_password_login_enabled

boolean

required

Default:

true

app_getting_started

string | null

optional

App template getting started text. Shown only if "include" contains app_getting_started.

Example

{
    "id": 2864,
    "hostname": "ubuntu-2gb",
    "billing_cycle": 1,
    "plan": {
        "id": 104,
        "type": "cloud-vps",
        "key": "string",
        "name": "cloud-vps-2gb",
        "vcpus": 2,
        "memory": 2,
        "disk": 50,
        "bandwidth": 5,
        "minimum_billing_cycle": 1,
        "plan_with_more_disk": 0,
        "plan_with_more_memory": 0,
        "available": true,
        "price": 100,
        "price_with_vat": 120
    },
    "status": "active",
    "virtualization": "kvm",
    "promo_code": null,
    "renew_amount": 100,
    "renew_amount_with_vat": 120,
    "locked": true,
    "created_at": "2024-08-29T14:21:54.000000Z",
    "expiry_at": "2024-10-27T11:03:10.000000Z",
    "potential_expiry_at": "2024-11-27T11:03:10.000000Z",
    "auto_renew": true,
    "show_smtp_form": true,
    "server_image": {
        "id": 73,
        "name": "Ubuntu 22.04",
        "eol": false,
        "group": {
            "name": "Ubuntu",
            "type": "os",
            "key": "ubuntu"
        }
    },
    "ip_addresses": [
        {
            "id": 10,
            "ip_address": "87.120.37.9",
            "prefix": 32,
            "version": 4,
            "type": "public",
            "main": false,
            "ddos_protected": false,
            "floating_ip": true,
            "floating_ip_id": 637,
            "ptr": null,
            "assigned_on": "2021-01-22T11:43:54.000000Z"
        },
        {
            "id": 48,
            "ip_address": "87.120.37.47",
            "prefix": 32,
            "version": 4,
            "type": "public",
            "main": true,
            "ddos_protected": false,
            "floating_ip": false,
            "floating_ip_id": null,
            "ptr": null,
            "assigned_on": "2025-03-14T11:52:22.000000Z"
        }
    ],
    "addons": [
        {
            "id": 801,
            "name": "backups",
            "status": "active",
            "quantity": 60,
            "amount": 36,
            "amount_with_vat": 43.2,
            "created_at": "2025-01-10 11:45:31",
            "ended_at": null
        },
        {
            "id": 802,
            "name": "100mbps-unmetered",
            "status": "active",
            "quantity": 1,
            "amount": 300,
            "amount_with_vat": 360,
            "created_at": "2025-01-16 14:29:56",
            "ended_at": null
        }
    ],
    "cancel_request": null,
    "settings": {
        "renew_enabled": true,
        "snapshots_enabled": true
    }
}

🟠401Unauthorized

🟠422Validation error (specified in the response)

🔴500Server Error