/manage/commands/commands.access.admin.cleanConfig

Check and clean all the missing references for users, gateways, and groups

Parameters

Field	Type	Description
api_key	string	API key

 

/manage/commands/commands.access.admin.connectDevice

Open a connection to an endpoint

Parameters

Field	Type	Description
device	string	endpoint name
api_key	string	API key
user	string	user name
gateway	string	gateway name

 

/manage/commands/commands.access.admin.connectEndpoint

Open a connection to an endpoint

Parameters

Field	Type	Description
device	string	endpoint name
api_key	string	API key
user	string	user name
gateway	string	gateway name

 

/manage/commands/commands.access.admin.connectGateway

Open a connection to a gateway

Parameters

Field	Type	Description
api_key	string	API key
user	string	user name
gateway	string	gateway name

 

/manage/commands/commands.access.admin.createDevice

Create an endpoint

Parameters

Field	Type	Description
remark	string	description
retrieve_attributes	string	optional comma-separated list of user attributes to be returned
name	string	name
enabled	string	enable/disable the endpoint
action_profile	string	application profile name
custom	string	custom options
physical_ip_address	string	IP address
api_key	string	API key
snat	string	enable/disable source nat
gateway	string	gateway name

 

/manage/commands/commands.access.admin.createDomain

Create an organization

Parameters

Field	Type	Description
organization	string	organization name
domain	string	parent organization identifier (optional)
api_key	string	API key
name	string	unique organization identifier
fqdn	string	fully qualified domain name (optional)

 

/manage/commands/commands.access.admin.createEndpoint

Create an endpoint

Parameters

Field	Type	Description
remark	string	description
retrieve_attributes	string	optional comma-separated list of user attributes to be returned
name	string	name
enabled	string	enable/disable the endpoint
action_profile	string	application profile name
custom	string	custom options
physical_ip_address	string	IP address
api_key	string	API key
snat	string	enable/disable source nat
gateway	string	gateway name

 

/manage/commands/commands.access.admin.createGateway

Create a gateway - additional parameters can be specified

Parameters

Field	Type	Description
remark	string	remark (optional)
api_key	string	API key
name	string	name password
domain	string	organization identifier (optional)

 

/manage/commands/commands.access.admin.createGatewayGroup

Create a gateway group

Parameters

Field	Type	Description
remark	string	remark (optional)
name	string	group name
domain	string	organization identifier (optional)
gatewaygroup_member	string	group members (optional)
gatewaygroup_regularuser	string	group regular users (optional)
api_key	string	API key
gatewaygroup_manager	string	group managers (optional)

 

/manage/commands/commands.access.admin.createUser

Create an user - additional parameters can be specified

Parameters

Field	Type	Description
remark	string	remark (optional)
name	string	name password
user_regularuserof	string	accessible gateways/gateway groups (optional)
domain	string	organization identifier (optional)
user_memberof	string	user groups (optional)
user_managerof	string	managed gateways/gateway groups (optional)
user_permissions	string	permissions (optional)
api_key	string	API key

 

/manage/commands/commands.access.admin.createUserGroup

Create an user group

Parameters

Field	Type	Description
remark	string	remark (optional)
name	string	group name
usergroup_regularuserof	string	gateway groups (optional)
domain	string	organization identifier (optional)
usergroup_member	string	group members (regular users) (optional)
usergroup_admin	string	group admins (optional)
api_key	string	API key
usergroup_managerof	string	managed gateway groups (optional)

 

/manage/commands/commands.access.admin.deleteDevice

Delete an endpoint by its name.Return a JSON dictionary of endpoint attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	endpoint name

 

/manage/commands/commands.access.admin.deleteDomain

Delete an organization

Parameters

Field	Type	Description
api_key	string	API key
name	string	group name

 

/manage/commands/commands.access.admin.deleteEndpoint

Delete an endpoint by its name.Return a JSON dictionary of endpoint attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	endpoint name

 

/manage/commands/commands.access.admin.deleteGateway

Delete a gateway

Parameters

Field	Type	Description
api_key	string	API key
name	string	name

 

/manage/commands/commands.access.admin.deleteGatewayGroup

Delete a gateway group

Parameters

Field	Type	Description
api_key	string	API key
name	string	group name

 

/manage/commands/commands.access.admin.deleteUser

Delete a user

Parameters

Field	Type	Description
api_key	string	API key
name	string	name

 

/manage/commands/commands.access.admin.deleteUserGroup

Delete an user group

Parameters

Field	Type	Description
api_key	string	API key
name	string	group name

 

/manage/commands/commands.access.admin.disconnectDevice

Close a connection to an endpoint

Parameters

Field	Type	Description
device	string	endpoint name
api_key	string	API key
user	string	user name

 

/manage/commands/commands.access.admin.disconnectEndpoint

Close a connection to an endpoint

Parameters

Field	Type	Description
device	string	endpoint name
api_key	string	API key
user	string	user name

 

/manage/commands/commands.access.admin.disconnectGateway

Close a connection to a gateway

Parameters

Field	Type	Description
api_key	string	API key
user	string	user name
gateway	string	gateway name

 

/manage/commands/commands.access.admin.getAction

Get an action for an endpoint

Parameters

Field	Type	Description
action	string	action name
device	string	endpoint name
api_key	string	API key

 

/manage/commands/commands.access.admin.getDevice

Get an endpoint by its name.Return a JSON dictionary of endpoint attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	endpoint fullname (e.g. endpoint123@gateway456)
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.getDomain

Get an organization by its name.Return a JSON dictionary of domain attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	unique organization identifier
retrieve_attributes	string	optional comma-separated list of organization attributes to be returned

 

/manage/commands/commands.access.admin.getEndpoint

Get an endpoint by its name.Return a JSON dictionary of endpoint attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	endpoint fullname (e.g. endpoint123@gateway456)
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.getGateway

Get a gateway by its name.Return a JSON dictionary of gateway attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	gateway name
retrieve_attributes	string	optional comma-separated list of gateway attributes to be returned

 

/manage/commands/commands.access.admin.getGatewayConfiguration

Get the gateway configuration by its name.Return a JSON dictionary of gateway configuration attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	gateway name

 

/manage/commands/commands.access.admin.getGatewayGroup

Get gateway group

Parameters

Field	Type	Description
api_key	string	API key
name	string	gateway group name
retrieve_attributes	string	optional comma-separated list of gateway group attributes to be returned

 

/manage/commands/commands.access.admin.getGatewayGroupLogs

Get gateway group logs

Parameters

Field	Type	Description
from_date	string	optional from data, in YYYY-MM-DD format
api_key	string	API key
limit	integer	max number of results
name	string	gateway group name
to_date	string	optional to data, in YYYY-MM-DD format

 

/manage/commands/commands.access.admin.getGatewayLogs

Get gateway logs

Parameters

Field	Type	Description
from_date	string	optional from data, in YYYY-MM-DD format
api_key	string	API key
limit	integer	max number of results
name	string	gateway name
to_date	string	optional to data, in YYYY-MM-DD format

 

/manage/commands/commands.access.admin.getGatewayProvisioning

Get the gateway configuration by its name.Return the YAML provisioning file for a given gateway.

Parameters

Field	Type	Description
password	string	gateway password
api_key	string	API key
name	string	gateway name

 

/manage/commands/commands.access.admin.getGatewayStatus

Get the gateway status by its name.Return the gateway status as JSON dictionary in case of success.

Parameters

Field	Type	Description
ping_attempts	integer	number of attempts
ping_timeout	integer	ping timeout in second
api_key	string	API key
ping	boolean	check endpoints connectivity
name	string	gateway name

 

/manage/commands/commands.access.admin.getGatewayStatusByEndpoint

Get gateway and endpoint status by endpoint name or custom field.Return the gateway status as JSON dictionary in case of success.

Parameters

Field	Type	Description
remark	string	endpoint description (optional)
name	string	endpoint name (optional)
all_endpoints	boolean	include other gateway endpoints in response (default: false)
ping	boolean	check endpoints connectivity (default: false)
custom	string	endpoint custom field (optional)
ping_attempts	integer	number of attempts
ping_timeout	integer	ping timeout in second
api_key	string	API key

 

/manage/commands/commands.access.admin.getStatistics

Return the usage statistics

Parameters

Field	Type	Description
api_key	string	API key
limit	integer	max number of results

 

/manage/commands/commands.access.admin.getStatisticsCSV

Export the statistics for each domain for a given period

Parameters

Field	Type	Description
start	string	optional start date formatted as YYYY-MM-DD
api_key	string	API key
end	string	optional end date formatted as YYYY-MM-DD

 

/manage/commands/commands.access.admin.getUser

Get an user by its name.Return a JSON dictionary of user attributes in case of success.

Parameters

Field	Type	Description
api_key	string	API key
name	string	user name
retrieve_attributes	string	optional comma-separated list of user attributes to be returned

 

/manage/commands/commands.access.admin.getUserGroup

Get user group

Parameters

Field	Type	Description
api_key	string	API key
name	string	user group name
retrieve_attributes	string	optional comma-separated list of user group attributes to be returned

 

/manage/commands/commands.access.admin.getUserGroupLogs

Get user group logs

Parameters

Field	Type	Description
from_date	string	optional from data, in YYYY-MM-DD format
api_key	string	API key
limit	integer	max number of results
name	string	user group name
to_date	string	optional to data, in YYYY-MM-DD format

 

/manage/commands/commands.access.admin.getUserLogs

Get user logs

Parameters

Field	Type	Description
from_date	string	optional from data, in YYYY-MM-DD format
api_key	string	API key
limit	integer	max number of results
name	string	user name
to_date	string	optional to data, in YYYY-MM-DD format

 

/manage/commands/commands.access.admin.listActionsForDevice

Return a list of actions that are available to the given endpoint

Parameters

Field	Type	Description
device	string	endpoint name
api_key	string	API key
gateway	string	gateway name

 

/manage/commands/commands.access.admin.listActionsForEndpoint

Return a list of actions that are available to the given endpoint

Parameters

Field	Type	Description
device	string	endpoint name
api_key	string	API key
gateway	string	gateway name

 

/manage/commands/commands.access.admin.listConnections

Return the list of the connections between users and endpoints

Parameters

Field	Type	Description
api_key	string	API key

 

/manage/commands/commands.access.admin.listDevices

Get the list of all the endpoints.For each endpoint, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.listDevicesForUser

Return a list of endpoints that are available to the given user

Parameters

Field	Type	Description
api_key	string	API key
name	string	user name
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.listDomains

Get the list of all the organizations.For each organization, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of organization attributes to be returned

 

/manage/commands/commands.access.admin.listEndpoints

Get the list of all the endpoints.For each endpoint, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.listEndpointsForUser

Return a list of endpoints that are available to the given user

Parameters

Field	Type	Description
api_key	string	API key
name	string	user name
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.listGatewayGroups

Get the list of all the gateway groups.For each gateway group, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of gateway group attributes to be returned

 

/manage/commands/commands.access.admin.listGateways

Get the list of all the gateways.For each gateway, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of gateway attributes to be returned

 

/manage/commands/commands.access.admin.listGatewaysForUser

Return a list of gateways that are available to the given user.

Parameters

Field	Type	Description
api_key	string	API key
name	string	user name
retrieve_attributes	string	optional comma-separated list of endpoint attributes to be returned

 

/manage/commands/commands.access.admin.listModels

Get the list of all the models

Parameters

Field	Type	Description
api_key	string	API key

 

/manage/commands/commands.access.admin.listUserGroups

Get the list of all the user groups.For each user group, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of user group attributes to be returned

 

/manage/commands/commands.access.admin.listUsers

Get the list of all the users.For each user, is extracted a subset of the attributes,specified by the retrieve_attributes parameter

Parameters

Field	Type	Description
api_key	string	API key
retrieve_attributes	string	optional comma-separated list of user attributes to be returned

 

/manage/commands/commands.access.admin.listVPNConnections

Return the list of the VPN connections (connected users and gateways)

Parameters

Field	Type	Description
api_key	string	API key

 

/manage/commands/commands.access.admin.loginTest

Try to Authenticate an user, identified by an username and a password.Return a JSON dictionary of user attributes in case of success.

Parameters

Field	Type	Description
password	string	password
api_key	string	API key
name	string	user or gateway name

 

/manage/commands/commands.access.admin.setDomain

Modify an organization

Parameters

Field	Type	Description
domain	string	parent organization identifier (optional)
api_key	string	API key
name	string	unique organization identifier
fqdn	string	fully qualified domain name (optional)

 

/manage/commands/commands.access.admin.setGateway

Modify a gateway - additional parameters can be specified

Parameters

Field	Type	Description
remark	string	remark (optional)
api_key	string	API key
name	string	name
domain	string	organization identifier (optional)

 

/manage/commands/commands.access.admin.setGatewayrGroup

Modify a gateway group

Parameters

Field	Type	Description
remark	string	remark (optional)
name	string	group name
domain	string	organization identifier (optional)
gatewaygroup_member	string	group members (optional)
gatewaygroup_regularuser	string	group regular users (optional)
api_key	string	API key
gatewaygroup_manager	string	group managers (optional)

 

/manage/commands/commands.access.admin.setUser

Modify a user - additional parameters can be specified

Parameters

Field	Type	Description
remark	string	remark (optional)
name	string	name password
user_regularuserof	string	accessible gateways/gateway groups (optional)
domain	string	organization identifier (optional)
user_memberof	string	user groups (optional)
user_managerof	string	managed gateways/gateway groups (optional)
user_permissions	string	permissions (optional)
api_key	string	API key

 

/manage/commands/commands.access.admin.setUserGroup

Modify an user group

Parameters

Field	Type	Description
remark	string	remark (optional)
name	string	group name
usergroup_regularuserof	string	gateway groups (optional)
domain	string	organization identifier (optional)
usergroup_member	string	group members (regular users) (optional)
usergroup_admin	string	group admins (optional)
api_key	string	API key
usergroup_managerof	string	managed gateway groups (optional)