Cosmic User API Reference

listRemoteAccessVpns

Lists remote access vpns

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists remote access vpn rule with the specified IDfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
networkidlist remote access VPNs for ceratin networkfalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
publicipidpublic ip address id of the vpn serverfalse

Response Tags

Response NameDescription
idthe id of the remote access vpn
accountthe account of the remote access vpn
domainthe domain name of the account of the remote access vpn
domainidthe domain id of the account of the remote access vpn
fordisplayis vpn for display to the regular user
iprangethe range of ips to allocate to the clients
presharedkeythe ipsec preshared key
projectthe project name of the vpn
projectidthe project id of the vpn
publicipthe public ip address of the vpn server
publicipidthe public ip address of the vpn server
statethe state of the rule