General information - VPSBG's dev hub

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

id

integer

required

Your IP Address identificator.

Header Params

Accept

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200General information

application/json

Body

under_attack

boolean

required

ip_address

object (IP address)

required

id

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:

4

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.

floating_ip_id

integer | null

optional

If the IP address is registered as a Floating IP, this is the ID of the Floating IP product.

expiry_at

string

required

protected_service

object | null

optional

id

integer | null

optional

type

string | null

optional

Type of the protected service. Possible values: server

label

string | null

optional

Label of the protected service. In case of it being a server, it will display the hostname of the server.

Example

{
    "under_attack": false,
    "ip_address": {
        "id": 2816,
        "ip_address": "10.10.10.10",
        "prefix": 32,
        "version": 4,
        "type": "public",
        "main": false,
        "ddos_protected": true,
        "floating_ip": true,
        "ptr": null,
        "assigned_on": "2024-09-07T14:18:19.000000Z"
    },
    "floating_ip_id": 25963458,
    "expiry_at": "2024-11-06T22:00:00.000000Z",
    "protected_service": {
        "id": 55667788,
        "type": "server",
        "label": "my.server.com"
    }
}

🟠401Unauthorized

🔴500Server Error