class PlatformAPI::VpnConnection

[VPN](devcenter.heroku.com/articles/private-space-vpn-connection) provides a way to connect your Private Spaces to your network via VPN.

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 3590
def initialize(client)
  @client = client
end

Public Instance Methods

create(space_id_or_space_name, body = {}) click to toggle source

Create a new VPN connection in a private space.

@param space_id_or_space_name: unique identifier of space or unique name of space @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 3598
def create(space_id_or_space_name, body = {})
  @client.vpn_connection.create(space_id_or_space_name, body)
end
destroy(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name) click to toggle source

Destroy existing VPN Connection

@param space_id_or_space_name: unique identifier of space or unique name of space @param vpn_connection_id_or_vpn_connection_name: VPN ID or VPN Name

# File lib/platform-api/client.rb, line 3606
def destroy(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name)
  @client.vpn_connection.destroy(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name)
end
info(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name) click to toggle source

Info for an existing vpn-connection.

@param space_id_or_space_name: unique identifier of space or unique name of space @param vpn_connection_id_or_vpn_connection_name: VPN ID or VPN Name

# File lib/platform-api/client.rb, line 3621
def info(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name)
  @client.vpn_connection.info(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name)
end
list(space_id_or_space_name) click to toggle source

List VPN connections for a space.

@param space_id_or_space_name: unique identifier of space or unique name of space

# File lib/platform-api/client.rb, line 3613
def list(space_id_or_space_name)
  @client.vpn_connection.list(space_id_or_space_name)
end
update(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name, body = {}) click to toggle source

Update a VPN connection in a private space.

@param space_id_or_space_name: unique identifier of space or unique name of space @param vpn_connection_id_or_vpn_connection_name: VPN ID or VPN Name @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 3630
def update(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name, body = {})
  @client.vpn_connection.update(space_id_or_space_name, vpn_connection_id_or_vpn_connection_name, body)
end