Internal Console API

InternalTunnelManager

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
String createManagementTunnel(String name, String palId, String syncMethod)

Creates a management tunnel and returns the key.
String createPalTunnel(String name, String palId, String scope)

Creates a pal tunnel and returns the key.
String createSubscriptionTunnel(String name, String palId, String scope)

Creates a subscription tunnel and returns the key.
  deleteTunnel(String tunnelId)

Deletes the tunnel.
  enableTunnel(String tunnelId, boolean enabled)

Enables or disables the tunnel for connections.
SystemDataView getInboundTunnels()

Returns a SystemDataView for accessing inbound tunnels for the enterprise.
SystemDataView getOutboundTunnels()

Returns a SystemDataView for accessing outbound tunnels for the enterprise.
boolean isEnabled()

Returns true if tunnel connections are allowed.
String joinTunnel(String name, String palId, String key)

Creates a tunnel and joins it to an endpoint. Returns null on fail.
  lockTunnel(String tunnelId, boolean locked)

Locks or unlocks the tunnel for registration.
boolean removeWorkflow(String tunnelId)

Removes the tunnel workflow.
  setEnabled(boolean enabled)

Blocks or allows tunnel connections.
boolean setWorkflow(String tunnelId, String workflow)

Specifies the tunnel workflow to run for the tunnel.
String toString()

Returns a description of this object.

Method Detail

String createManagementTunnel(String name, String palId, String syncMethod)

Creates a management tunnel and returns the key.

Parameters:

  • String   name Maximum allowed size of parameter: 100
  • String   palId
  • String   syncMethod  - m=manual, a=automatic, d=deploy, c=controlled.

Returns:  String

Since: 06-14-2018

top
String createPalTunnel(String name, String palId, String scope)

Creates a pal tunnel and returns the key.

Parameters:

  • String   name Maximum allowed size of parameter: 100
  • String   palId
  • String   scope

Returns:  String

Since: 06-14-2018

top
String createSubscriptionTunnel(String name, String palId, String scope)

Creates a subscription tunnel and returns the key.

Parameters:

  • String   name Maximum allowed size of parameter: 100
  • String   palId
  • String   scope

Returns:  String

Since: 06-03-2020

top
deleteTunnel(String tunnelId)

Deletes the tunnel.

Parameters:

  • String   tunnelId

Since: 06-14-2018

top
enableTunnel(String tunnelId, boolean enabled)

Enables or disables the tunnel for connections.

Parameters:

  • String   tunnelId
  • boolean   enabled

Since: 06-14-2018

top
SystemDataView getInboundTunnels()

Returns a SystemDataView for accessing inbound tunnels for the enterprise.

Returns:  SystemDataView


DataList Name: InboundTunnels
DataList Keys/Column Name Column Type Read Only
tunnelId String  
name String  
palId String  
palName String  
joined Boolean  
joinDate Date  
createDate Date  
enabled Boolean  
locked Boolean  
syncMethod String  
type String  
scope String  
clientHost String  
clientEnterpriseId String  
clientPalId String  
workflow String  
firstName String  
lastName String  
email String  

Since: 06-14-2018

top
SystemDataView getOutboundTunnels()

Returns a SystemDataView for accessing outbound tunnels for the enterprise.

Returns:  SystemDataView


DataList Name: OutboundTunnels
DataList Keys/Column Name Column Type Read Only
tunnelId String  
name String  
palId String  
palName String  
createDate Date  
type String  
host String  
targetTunnelId String  
syncMethod String  
firstName String  
lastName String  
email String  

Since: 06-14-2018

top
boolean isEnabled()

Returns true if tunnel connections are allowed.

Returns:  boolean

Since: 06-14-2018

top
String joinTunnel(String name, String palId, String key)

Creates a tunnel and joins it to an endpoint. Returns null on fail.

Parameters:

  • String   name Maximum allowed size of parameter: 100
  • String   palId
  • String   key

Returns:  String

Since: 06-14-2018

top
lockTunnel(String tunnelId, boolean locked)

Locks or unlocks the tunnel for registration.

Parameters:

  • String   tunnelId
  • boolean   locked

Since: 06-14-2018

top
boolean removeWorkflow(String tunnelId)

Removes the tunnel workflow.

Parameters:

  • String   tunnelId

Returns:  boolean

Since: 01-10-2020

top
setEnabled(boolean enabled)

Blocks or allows tunnel connections.

Parameters:

  • boolean   enabled

Since: 06-14-2018

top
boolean setWorkflow(String tunnelId, String workflow)

Specifies the tunnel workflow to run for the tunnel.

Parameters:

  • String   tunnelId
  • String   workflow Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 01-10-2020

top
String toString()

Returns a description of this object.

Returns:  String

Since: 06-14-2018

top
Copyright © 2006 - 2025, ContractPal, Inc. All rights reserved. API Date: Oct 22, 2025 03:32 PM