Get Server

Get OpenBlu Server

This method allows you to get an existing server from OpenBlu. This includes the certificate, connection parameters, IP address and more.

Endpoint Parameters

Parameter Name	Default Value	Required	Description
id	`NULL`	True	The ID of the VPN Server

Example Success Response

Some of the data is replaced with <> to simplify the contents

{
  "success":true,
  "response_code":200,
  "server":{
    "id":"ffd07d9e2adf70ef",
    "host_name":"vpn853872483",
    "country":"Japan",
    "country_short":"JP",
    "score":398502,
    "ping":1,
    "sessions":47,
    "total_sessions":417240,
    "ip_address":"103.201.129.18",
    "openvpn":{
      "parameters":{
        "dev":"tun",
        "proto":"tcp",
        "remote":"103.201.129.18 443",
        "cipher":"AES-128-CBC",
        "auth":"SHA1",
        "resolv-retry":"infinite",
        "nobind":null,
        "persist-key":null,
        "persist-tun":null,
        "client":null,
        "verb":"3"
      },
      "certificate_authority":"<CERTIFICATE DATA>",
      "certificate_authority_b64":"<BASE64 ENCODED CERTIFICATE DATA>",
      "certificate":"<CERTIFICATE DATA>",
      "certificate_b64":"<BASE64 ENCODED CERTIFICATE DATA>",
      "key":"<PRIVATE KEY DATA>",
      "key_b64":"<BASE64 ENCODED PRIVATE KEY DATA>",
      "ovpn_configuration":"<.OVPN FILE CONTENTS>"
    },
    "last_updated":1580340394,
    "created":1580070319
  }
}

Server Object Structure

Name	Type	Description
id	`string`	The ID of the server
host_name	`string`	The name of the host of the server
country	`string`	The full name of the country that this server is based in
country_short	`string`	The short version of the country that this server is based in
score	`int`	The score of the server
ping	`int`	The ping of the server
sessions	`int`	The amount of sessions that are currently established to this server
total_sessions	`int`	The total amount of sessions that has been established
ip_address	`string`	IPV4/IPV6 Address of the server
openvpn	`openvpn`	The OpenVPN details for connecting to this server
last_updated	`int`	The Unix Timestamp of when this server was last updated
created	`int`	The Unix Timestamp of when this server was created

OpenVPN Object Structure

Name	Type	Description
parameters	`array(key:string)/(key:null)`	The parameters for a OpenVPN Client to use, null values means that the parameter does not require a value
certificate_authority	`string`	The certificate authority of for the VPN Server
certificate_authority_b64	`string`	The same as certificate_authority but with the contents base64 encoded
certificate	`string`	The certificate of the VPN Server
certificate_b64	`string`	The same as certificate but with the contents base64 encoded
key	`string`	Private RSA Key for the VPN Server
key_b64	`string`	The same as key but with the contents base64 encoded
ovpn_configuration	`string`	The full contents of the .ovpn file including all the certificates and parameters to connect

Server Not Found Response

This response is given when the given ID does not point to any existing server that is registered in OpenBlu

{
  "success": false,
  "response_code": 404,
  "error": {
    "error_code": 1,
    "type": "CLIENT",
    "message": "VPN Server not found"
  }
}