Get Application by Id
- 23 Jul 2025
- 5 Minutes to read
- Contributors
Get Application by Id
- Updated on 23 Jul 2025
- 5 Minutes to read
- Contributors
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/v2.2/applications/{applicationId}
This GET API will allow to retrieve detailed information for a specific application by Id. Required permissions [application:read]
Security
HTTP
Type bearer
Path parameters
applicationId
stringRequired
Responses
200
Application retrieved successfully
OneOf
object
object
id
string
Unique application ID
name
string
Application name
type
string
Application type
Valid values[ "http", "https", "rdp", "ssh", "vnc" ]
enabled
boolean
Application enabling status
policy
object
Application related Policy data
id
string
Policy Id
name
string
Policy name
createdAt
string
Application create date
network
object
Application related Network data
id
string
Network Id
name
string
Network name
dns
string
DNS of the network
subnet
string
Subnet of the network
icon
object
Application icon
name
string
Icon name
url
string
Icon URL
users
Array of object
List of IDs of assigned users
object
Application users
id
string
Unique User ID
fullName
string
User's firstname and lastname
username
string
User's username
groups
Array of object
List of IDs of assigned groups
object
Application groups
id
string
Unique Group ID
name
string
Group's name
auth
object (ApplicationAuth)
Authentication settings related to the application
authEnabled
boolean
authUsername
string
Min length1
authPassword
string
Min length1
authDomain
string
Pattern^(?!:\/\/)([a-zA-Z0-9-_]+\.)*[a-zA-Z0-9][a-zA-Z0-9-_]*\.[a-zA-Z0-9]{2,11}?$
Exampledomain.com
alias
object (ApplicationAlias)
URL alias settings to access the application via a user-friendly URL under your own domain
aliasEnabled
boolean
cname
string
Min length1
sslCertificate
string
Min length1
displayIconAtLogin
boolean
Determines if the application icon is displayed during user login
fqdn
string
Fully qualified domain name (FQDN) associated with the application
Min length1
host
object (ApplicationHost)
Application host settings
value
string
Min length1
source
string
Min length1
port
object (ApplicationPort)
Application port settings
value
OneOf
integer
integer
Minimum1
Maximum65353
string
string
Min length1
source
string
Min length1
updatedAt
string
Application update date
headers
object
Web Application headers
attributes
object (HttpAttributes)
HTTP Application attributes
checkStatus
integer
Default200
checkPath
string
Default""
ExamplecheckPath
startRelativePath
string
Default""
Pattern^$|^\/[\w\d-._~!$&'()*+,;=:@/?#%]+$
Example/startRelativePath
object
object
id
string
Unique application ID
name
string
Application name
type
string
Application type
Valid values[ "http", "https", "rdp", "ssh", "vnc" ]
enabled
boolean
Application enabling status
policy
object
Application related Policy data
id
string
Policy Id
name
string
Policy name
createdAt
string
Application create date
network
object
Application related Network data
id
string
Network Id
name
string
Network name
dns
string
DNS of the network
subnet
string
Subnet of the network
icon
object
Application icon
name
string
Icon name
url
string
Icon URL
users
Array of object
List of IDs of assigned users
object
Application users
id
string
Unique User ID
fullName
string
User's firstname and lastname
username
string
User's username
groups
Array of object
List of IDs of assigned groups
object
Application groups
id
string
Unique Group ID
name
string
Group's name
auth
object (ApplicationAuth)
Authentication settings related to the application
authEnabled
boolean
authUsername
string
Min length1
authPassword
string
Min length1
authDomain
string
Pattern^(?!:\/\/)([a-zA-Z0-9-_]+\.)*[a-zA-Z0-9][a-zA-Z0-9-_]*\.[a-zA-Z0-9]{2,11}?$
Exampledomain.com
alias
object (ApplicationAlias)
URL alias settings to access the application via a user-friendly URL under your own domain
aliasEnabled
boolean
cname
string
Min length1
sslCertificate
string
Min length1
displayIconAtLogin
boolean
Determines if the application icon is displayed during user login
fqdn
string
Fully qualified domain name (FQDN) associated with the application
Min length1
host
object (ApplicationHost)
Application host settings
value
string
Min length1
source
string
Min length1
port
object (ApplicationPort)
Application port settings
value
OneOf
integer
integer
Minimum1
Maximum65353
string
string
Min length1
source
string
Min length1
updatedAt
string
Application update date
headers
object
Web Application headers
attributes
object
checkStatus
integer
Default200
checkPath
string
Default""
ExamplecheckPath
startRelativePath
string
Default""
Pattern^$|^\/[\w\d-._~!$&'()*+,;=:@/?#%]+$
Example/startRelativePath
sslCertificateVerification
boolean
Defaulttrue
object
object
id
string
Unique application ID
name
string
Application name
type
string
Application type
Valid values[ "http", "https", "rdp", "ssh", "vnc" ]
enabled
boolean
Application enabling status
policy
object
Application related Policy data
id
string
Policy Id
name
string
Policy name
createdAt
string
Application create date
network
object
Application related Network data
id
string
Network Id
name
string
Network name
dns
string
DNS of the network
subnet
string
Subnet of the network
icon
object
Application icon
name
string
Icon name
url
string
Icon URL
users
Array of object
List of IDs of assigned users
object
Application users
id
string
Unique User ID
fullName
string
User's firstname and lastname
username
string
User's username
groups
Array of object
List of IDs of assigned groups
object
Application groups
id
string
Unique Group ID
name
string
Group's name
auth
object (ApplicationAuth)
Authentication settings related to the application
authEnabled
boolean
authUsername
string
Min length1
authPassword
string
Min length1
authDomain
string
Pattern^(?!:\/\/)([a-zA-Z0-9-_]+\.)*[a-zA-Z0-9][a-zA-Z0-9-_]*\.[a-zA-Z0-9]{2,11}?$
Exampledomain.com
alias
object (ApplicationAlias)
URL alias settings to access the application via a user-friendly URL under your own domain
aliasEnabled
boolean
cname
string
Min length1
sslCertificate
string
Min length1
displayIconAtLogin
boolean
Determines if the application icon is displayed during user login
fqdn
string
Fully qualified domain name (FQDN) associated with the application
Min length1
host
object (ApplicationHost)
Application host settings
value
string
Min length1
source
string
Min length1
port
object (ApplicationPort)
Application port settings
value
OneOf
integer
integer
Minimum1
Maximum65353
string
string
Min length1
source
string
Min length1
updatedAt
string
Application update date
attributes
object (RdpAttributes)
RDP Application attributes
clientType
string
RDP client type
Valid values[ "web", "native" ]
Default"web"
disableClipboard
boolean
Defaultfalse
disablePrinting
boolean
Defaultfalse
ignoreTLSVerification
boolean
Defaulttrue
adminConsole
boolean
Defaultfalse
maxConnections
OneOf
integer
integer
Minimum1
Maximum1024
Default32
integer
integer
Minimum1
Maximum1
Default1
rdpSecurity
OneOf
string
string
Valid values[ "any", "nla", "nla-ext", "tls", "vmconnect", "rdp" ]
Default"any"
string
string
Valid values[ "any" ]
Default"any"
enableMultiMonitors
boolean
object
object
id
string
Unique application ID
name
string
Application name
type
string
Application type
Valid values[ "http", "https", "rdp", "ssh", "vnc" ]
enabled
boolean
Application enabling status
policy
object
Application related Policy data
id
string
Policy Id
name
string
Policy name
createdAt
string
Application create date
network
object
Application related Network data
id
string
Network Id
name
string
Network name
dns
string
DNS of the network
subnet
string
Subnet of the network
icon
object
Application icon
name
string
Icon name
url
string
Icon URL
users
Array of object
List of IDs of assigned users
object
Application users
id
string
Unique User ID
fullName
string
User's firstname and lastname
username
string
User's username
groups
Array of object
List of IDs of assigned groups
object
Application groups
id
string
Unique Group ID
name
string
Group's name
auth
object (ApplicationAuth)
Authentication settings related to the application
authEnabled
boolean
authUsername
string
Min length1
authPassword
string
Min length1
authDomain
string
Pattern^(?!:\/\/)([a-zA-Z0-9-_]+\.)*[a-zA-Z0-9][a-zA-Z0-9-_]*\.[a-zA-Z0-9]{2,11}?$
Exampledomain.com
alias
object (ApplicationAlias)
URL alias settings to access the application via a user-friendly URL under your own domain
aliasEnabled
boolean
cname
string
Min length1
sslCertificate
string
Min length1
displayIconAtLogin
boolean
Determines if the application icon is displayed during user login
fqdn
string
Fully qualified domain name (FQDN) associated with the application
Min length1
host
object (ApplicationHost)
Application host settings
value
string
Min length1
source
string
Min length1
port
object (ApplicationPort)
Application port settings
value
OneOf
integer
integer
Minimum1
Maximum65353
string
string
Min length1
source
string
Min length1
updatedAt
string
Application update date
attributes
object (SshAttributes)
SSH Application attributes
maxConnections
integer
object
object
id
string
Unique application ID
name
string
Application name
type
string
Application type
Valid values[ "http", "https", "rdp", "ssh", "vnc" ]
enabled
boolean
Application enabling status
policy
object
Application related Policy data
id
string
Policy Id
name
string
Policy name
createdAt
string
Application create date
network
object
Application related Network data
id
string
Network Id
name
string
Network name
dns
string
DNS of the network
subnet
string
Subnet of the network
icon
object
Application icon
name
string
Icon name
url
string
Icon URL
users
Array of object
List of IDs of assigned users
object
Application users
id
string
Unique User ID
fullName
string
User's firstname and lastname
username
string
User's username
groups
Array of object
List of IDs of assigned groups
object
Application groups
id
string
Unique Group ID
name
string
Group's name
auth
object (ApplicationAuth)
Authentication settings related to the application
authEnabled
boolean
authUsername
string
Min length1
authPassword
string
Min length1
authDomain
string
Pattern^(?!:\/\/)([a-zA-Z0-9-_]+\.)*[a-zA-Z0-9][a-zA-Z0-9-_]*\.[a-zA-Z0-9]{2,11}?$
Exampledomain.com
alias
object (ApplicationAlias)
URL alias settings to access the application via a user-friendly URL under your own domain
aliasEnabled
boolean
cname
string
Min length1
sslCertificate
string
Min length1
displayIconAtLogin
boolean
Determines if the application icon is displayed during user login
fqdn
string
Fully qualified domain name (FQDN) associated with the application
Min length1
host
object (ApplicationHost)
Application host settings
value
string
Min length1
source
string
Min length1
port
object (ApplicationPort)
Application port settings
value
OneOf
integer
integer
Minimum1
Maximum65353
string
string
Min length1
source
string
Min length1
updatedAt
string
Application update date
attributes
object (VncAttributes)
VNC Application attributes
maxConnections
integer
disableClipboard
boolean
400
Bad Request
401
Not Authorized
403
Forbidden
404
Application Not Found
500
Internal Server Error
Was this article helpful?