VPN

Live

VPN

+ Day(s) remaining in the trial

Overview

The IBM Virtual Private Network (VPN) service provides a secure IP-layer connectivity between your on-premise data center and your IBM Bluemix cloud. It leverages Internet Protocol Security (IPsec) protocol suite for protecting IP communication between endpoints residing on your private subnets. An IPsec-compatible VPN gateway is required in your on-premise data center for establishing secure connectivity with IBM VPN service. No other client software is necessary. - X-Auth-Token = `Bearer Token` - X-Auth-Project-Id = `Space Id` Base URL - Region US South: https://containers-api.ng.bluemix.net:443/v3/vpns - Region United Kingdom: https://containers-api.eu-gb.bluemix.net:443/v3/vpns

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

connections

/connections/{id}-DELETE
Delete an vpn connection

DELETE   /connections/{id}

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections/{id}
		
Keys
Header parameters

X-Auth-Project-Id

STRING , optional

Space GUID.

X-Auth-Token

STRING , optional

Bluemix JWT token (not prepended with 'bearer ').

Request code
								
HttpResponse<String> response = Unirest.delete("https://containers-api.ng.bluemix.net/v3/vpns/connections/{id_string}") .header("x-auth-project-id", "string") .header("x-auth-token", "string") .header("accept", "application/json") .header("content-type", "application/json") .asString();
/connections/{id}-GET
Show vpn connection details

GET   /connections/{id}

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections/{id}
		
Keys
Header parameters

X-Auth-Project-Id

STRING , optional

Space GUID.

X-Auth-Token

STRING , optional

Bluemix JWT token (not prepended with 'bearer ').

Request code
								
HttpResponse<String> response = Unirest.get("https://containers-api.ng.bluemix.net/v3/vpns/connections/{id_string}") .header("x-auth-token", "string") .header("x-auth-project-id", "string") .header("accept", "application/json") .asString();
/connections/{id}-PUT
Update vpn connection details

PUT   /connections/{id}

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections/{id}
		
Keys
Header parameters

X-Auth-Project-Id

STRING , optional

Space GUID.

X-Auth-Token

STRING , optional

Bluemix JWT token (not prepended with 'bearer ').

Request code
								
HttpResponse<String> response = Unirest.put("https://containers-api.ng.bluemix.net/v3/vpns/connections/{id_string}") .header("x-auth-project-id", "string") .header("x-auth-token", "string") .header("accept", "application/json") .header("content-type", "application/json") .body("{\"admin_state\":\"UP\",\"customer_gateway\":\"20.20.20.1\",\"customer_gateway_id\":\"20.20.20.1\",\"customer_subnets\":[null],\"description\":\"string\",\"dpd\":{\"description\":\"undefined\",\"properties\":{\"action\":\"string\",\"interval\":0,\"timeout\":0},\"type\":\"object\"},\"id\":\"804ab120-dabf-11e5-9504-0242ac11000a\",\"mtu\":1500,\"name\":\"connection1\",\"psk\":\"234abc\"}") .asString();
Request model

id

STRING , optional

optional, will be automatically generated if not present

mtu

INTEGER , optional

Ex: 1500

admin_state

STRING , optional

undefined

description

STRING , optional

undefined

name

STRING , optional

Ex: connection

psk

STRING , optional

Ex: 123456 (Need at least 6 characters)

customer_gateway

STRING , optional

Ex: 20.20.20.1

customer_gateway_id

STRING , optional

Ex: 20.20.20.1

customer_subnets

ARRAY , optional

undefined

dpd

object , optional

undefined

interval

INTEGER , optional

Ex: 30

action

STRING , optional

Ex: hold

timeout

INTEGER , optional

Ex: 120

Request example
{
  "id": "804ab120-dabf-11e5-9504-0242ac11000a",
  "mtu": 1500,
  "admin_state": "UP",
  "description": string,
  "name": "connection1",
  "psk": "234abc",
  "customer_gateway": "20.20.20.1",
  "customer_gateway_id": "20.20.20.1",
  "customer_subnets": [],
  "dpd": {
    "interval": integer,
    "action": string,
    "timeout": integer
  }
}
Response model

200

successful response

Body

mtu

INTEGER , optional

Ex: 1500

ikepolicy_id

STRING , optional

ID of IKE policy

gateway_id

STRING , optional

undefined

status

STRING , optional

status

auth_mode

STRING , optional

undefined

gateway_ip

STRING , optional

undefined

customer_gateway

STRING , optional

Ex: 20.20.20.1

customer_subnets

ARRAY , optional

undefined

id

STRING , optional

ID of connection

gateway_type

STRING , optional

allSingleContainers/allContainerGroups/allContainers

initiator

STRING , optional

Ex: bi-directional

ikepolicy_name

STRING , optional

Name of IKE policy

admin_state

STRING , optional

undefined

description

STRING , optional

undefined

name

STRING , optional

Ex: connection

gateway_name

STRING , optional

Name of gateway

psk

STRING , optional

Ex: 123

customer_gateway_id

STRING , optional

Ex: 20.20.20.1

ipsecpolicy_id

STRING , optional

ID of IPsec policy

ipsecpolicy_name

STRING , optional

Name of IPsec policy

dpd

object , optional

undefined

interval

INTEGER , optional

Ex: 30

action

STRING , optional

Ex: hold

timeout

INTEGER , optional

Ex: 120

Response example

200

successful response

								{
  "mtu" : integer,
  "ikepolicy_id" : string,
  "gateway_id" : string,
  "status" : string,
  "auth_mode" : string,
  "gateway_ip" : string,
  "customer_gateway" : string,
  "customer_subnets" : [array],
  "id" : string,
  "gateway_type" : string,
  "initiator" : string,
  "ikepolicy_name" : string,
  "admin_state" : string,
  "description" : string,
  "name" : string,
  "gateway_name" : string,
  "psk" : string,
  "customer_gateway_id" : string,
  "ipsecpolicy_id" : string,
  "ipsecpolicy_name" : string,
  "dpd" : {
    "interval" : integer,
    "action" : string,
    "timeout" : integer
  }
}
							
/connections-DELETE
Delete an vpn connection

DELETE   /connections

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections
		
Keys
Header parameters

X-Auth-Token

HEADER , optional

Bluemix JWT token (not prepended with 'bearer ').

X-Auth-Project-Id

HEADER , optional

Space GUID.

Request code
								
HttpResponse<String> response = Unirest.delete("https://containers-api.ng.bluemix.net/v3/vpns/connections") .header("x-auth-project-id", "string") .header("x-auth-token", "string") .header("accept", "application/json") .header("content-type", "application/json") .asString();
/connections-GET
Show vpn connection details

GET   /connections

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections
		
Keys
Header parameters

X-Auth-Token

STRING , optional

Bluemix JWT token (not prepended with 'bearer ').

X-Auth-Project-Id

STRING , optional

Space GUID.

Request code
								
HttpResponse<String> response = Unirest.get("https://containers-api.ng.bluemix.net/v3/vpns/connections") .header("x-auth-token", "string") .header("x-auth-project-id", "string") .header("accept", "application/json") .asString();
Response model

200

successful response

Body

connections

object , optional

connections

mtu

INTEGER , optional

Ex: 1500

ikepolicy_id

STRING , optional

ID of IKE policy

gateway_id

STRING , optional

undefined

status

STRING , optional

status

auth_mode

STRING , optional

undefined

gateway_ip

STRING , optional

undefined

customer_gateway

STRING , optional

Ex: 20.20.20.1

customer_subnets

ARRAY , optional

undefined

id

STRING , optional

ID of connection

gateway_type

STRING , optional

allSingleContainers/allContainerGroups/allContainers

initiator

STRING , optional

Ex: bi-directional

ikepolicy_name

STRING , optional

Name of IKE policy

admin_state

STRING , optional

undefined

description

STRING , optional

undefined

name

STRING , optional

Ex: connection

gateway_name

STRING , optional

Name of gateway

psk

STRING , optional

Ex: 123

customer_gateway_id

STRING , optional

Ex: 20.20.20.1

ipsecpolicy_id

STRING , optional

ID of IPsec policy

ipsecpolicy_name

STRING , optional

Name of IPsec policy

dpd

object , optional

undefined

interval

INTEGER , optional

Ex: 30

action

STRING , optional

Ex: hold

timeout

INTEGER , optional

Ex: 120

Response example

200

successful response

								{
  "connections" : {
    "mtu" : integer,
    "ikepolicy_id" : string,
    "gateway_id" : string,
    "status" : string,
    "auth_mode" : string,
    "gateway_ip" : string,
    "customer_gateway" : string,
    "customer_subnets" : [array],
    "id" : string,
    "gateway_type" : string,
    "initiator" : string,
    "ikepolicy_name" : string,
    "admin_state" : string,
    "description" : string,
    "name" : string,
    "gateway_name" : string,
    "psk" : string,
    "customer_gateway_id" : string,
    "ipsecpolicy_id" : string,
    "ipsecpolicy_name" : string,
    "dpd" : {
    "interval" : integer,
    "action" : string,
    "timeout" : integer
  }
  }
}
							
/connections-POST
Creates an vpn connection

POST   /connections

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections
		
Keys
Header parameters

X-Auth-Project-Id

STRING , optional

Space GUID.

X-Auth-Token

STRING , optional

Bluemix JWT token (not prepended with 'bearer ').

Request code
								
HttpResponse<String> response = Unirest.post("https://containers-api.ng.bluemix.net/v3/vpns/connections") .header("x-auth-token", "string") .header("x-auth-project-id", "string") .header("accept", "application/json") .header("content-type", "application/json") .body("{\"admin_state\":\"UP\",\"customer_gateway\":\"20.20.20.1\",\"customer_gateway_id\":\"20.20.20.1\",\"customer_subnets\":[null],\"description\":\"string\",\"dpd\":{\"description\":\"undefined\",\"properties\":{\"action\":\"string\",\"interval\":0,\"timeout\":0},\"type\":\"object\"},\"gateway_id\":\"7144f906-da9c-11e5-8014-0242ac11000a\",\"gateway_name\":\"gateway\",\"id\":\"804ab120-dabf-11e5-9504-0242ac11000a\",\"ikepolicy_id\":\"bc6eeff2-dab7-11e5-bf42-0242ac11000a\",\"ikepolicy_name\":\"ikepolicy\",\"ipsecpolicy_id\":\"33285df2-daba-11e5-9504-0242ac11000a\",\"ipsecpolicy_name\":\"ipsecpolicy\",\"mtu\":0,\"name\":\"connection\",\"psk\":\"234abc\"}") .asString();
Request model

mtu

INTEGER , optional

Ex: 1500

ikepolicy_id

STRING , optional

secondary key to identify the ikepolicy, will use the ikepolicy_name to identify the ikepolicy if not present

gateway_id

STRING , optional

undefined

customer_gateway

STRING , optional

Ex: 20.20.20.1

customer_subnets

ARRAY , optional

undefined

id

STRING , optional

optional, will be automatically generated if not present

description

STRING , optional

undefined

admin_state

STRING , optional

undefined

ikepolicy_name

STRING , optional

primay key to identify the ikepolicy, will use the ikepolicy_id to identify the ikepolicy if not present

name

STRING , optional

Ex: connection

gateway_name

STRING , optional

primay key to identify the gateway, will use the gateway_id to identify the gateway if not present

psk

STRING , optional

Ex: 123456 (Need at least 6 characters)

customer_gateway_id

STRING , optional

Ex: 20.20.20.1

ipsecpolicy_id

STRING , optional

secondary key to identify the ipsecpolicy, will use the ipsecpolicy_name to identify the ipsecpolicy if not present

ipsecpolicy_name

STRING , optional

primay key to identify the ipsecpolicy, will use the ipsecpolicy_id to identify the ipsecpolicy if not present

dpd

object , optional

undefined

interval

INTEGER , optional

Ex: 30

action

STRING , optional

Ex: hold

timeout

INTEGER , optional

Ex: 120

Request example
{
  "mtu": integer,
  "ikepolicy_id": "bc6eeff2-dab7-11e5-bf42-0242ac11000a",
  "gateway_id": "7144f906-da9c-11e5-8014-0242ac11000a",
  "customer_gateway": "20.20.20.1",
  "customer_subnets": [],
  "id": "804ab120-dabf-11e5-9504-0242ac11000a",
  "description": string,
  "admin_state": "UP",
  "ikepolicy_name": "ikepolicy",
  "name": "connection",
  "gateway_name": "gateway",
  "psk": "234abc",
  "customer_gateway_id": "20.20.20.1",
  "ipsecpolicy_id": "33285df2-daba-11e5-9504-0242ac11000a",
  "ipsecpolicy_name": "ipsecpolicy",
  "dpd": {
    "interval": 30,
    "action": "hold",
    "timeout": 120
  }
}
/connections-PUT
Update vpn connection details

PUT   /connections

			https://containers-api.ng.bluemix.net:443/v3/vpns/connections
		
Keys
Header parameters

X-Auth-Token

STRING , optional

Bluemix JWT token (not prepended with 'bearer ').

X-Auth-Project-Id

STRING , optional

Space GUID.

Request code
								
HttpResponse<String> response = Unirest.put("https://containers-api.ng.bluemix.net/v3/vpns/connections") .header("x-auth-token", "string") .header("x-auth-project-id", "string") .header("accept", "application/json") .header("content-type", "application/json") .body("{\"admin_state\":\"UP\",\"customer_gateway\":\"20.20.20.1\",\"customer_gateway_id\":\"20.20.20.1\",\"customer_subnets\":[null],\"description\":\"string\",\"dpd\":{\"description\":\"undefined\",\"properties\":{\"action\":\"string\",\"interval\":0,\"timeout\":0},\"type\":\"object\"},\"id\":\"804ab120-dabf-11e5-9504-0242ac11000\",\"mtu\":1500,\"name\":\"connection1\",\"psk\":\"123abc\"}") .asString();
Request model

id

STRING , optional

optional, will be automatically generated if not present

mtu

INTEGER , optional

Ex: 1500

admin_state

STRING , optional

undefined

description

STRING , optional

undefined

name

STRING , optional

Ex: connection

psk

STRING , optional

Ex: 123456 (Need at least 6 characters)

customer_gateway

STRING , optional

Ex: 20.20.20.1

customer_gateway_id

STRING , optional

Ex: 20.20.20.1

customer_subnets

ARRAY , optional

undefined

dpd

object , optional

undefined

interval

INTEGER , optional

Ex: 30

action

STRING , optional

Ex: hold

timeout

INTEGER , optional

Ex: 120

Request example
{
  "id": "804ab120-dabf-11e5-9504-0242ac11000",
  "mtu": 1500,
  "admin_state": "UP",
  "description": string,
  "name": "connection1",
  "psk": "123abc",
  "customer_gateway": "20.20.20.1",
  "customer_gateway_id": "20.20.20.1",
  "customer_subnets": [],
  "dpd": {
    "interval": integer,
    "action": string,
    "timeout": integer
  }
}

Loading content...