Create Application
- 23 Jul 2025
- 3 Minutes to read
-
Contributors
Create Application
- Updated on 23 Jul 2025
- 3 Minutes to read
-
Contributors
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/v2.2/applications
This POST API will allow to create a new application. Required permissions [application:create]
Security
HTTP
Type bearer
Body parameters
OneOf
object
object
headers
object Required
Application specific headers. Keys must not contain . and $
Pattern^[^.$]+$
Example{
"X-Custom-Header": "value"
}
attributes
object (HttpAttributes) Required
HTTP Application attributes
checkStatus
integer
Default200
checkPath
string
Default""
ExamplecheckPath
startRelativePath
string
Default""
Pattern^$|^\/[\w\d-._~!$&'()*+,;=:@/?#%]+$
Example/startRelativePath
OneOf
object
object
users
Array Required
name
string
Application name
Min length5
Max length32
Pattern^[^~`()!#$%^&*+=[]\';,/{}|":<>?№@]+$
ExampleMyApplication
type
string
Application type
Valid values[
"http",
"https",
"rdp"
]
network
ExampleZwAeo5wqiF
host
OneOf
FixedHost
object (FixedHost)
source
string Required
Application host source
Valid values[
"fixed"
]
value
OneOf
IdpHost
object (IdpHost)
source
string Required
Application host source
Valid values[
"idp"
]
value
string Required
Application host value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
port
OneOf
FixedPort
object (FixedPort)
source
string Required
Application port source
Valid values[
"fixed"
]
value
Example443
IdpPort
object (IdpPort)
source
string Required
Application port source
Valid values[
"idp"
]
value
string Required
Application port value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
groups
Array of string (AlphanumericWithSpace)
List of IDs of assigned groups. To get the IDs use endpoint '/groups' with [group:read] permission.
Min items1
Example[
"mWKM26JMc1",
"mWKM26JMc2"
]
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
object
object
groups
Array Required
name
string
Application name
Min length5
Max length32
Pattern^[^~`()!#$%^&*+=[]\';,/{}|":<>?№@]+$
ExampleMyApplication
type
string
Application type
Valid values[
"http",
"https",
"rdp"
]
network
ExampleZwAeo5wqiF
host
OneOf
FixedHost
object (FixedHost)
source
string Required
Application host source
Valid values[
"fixed"
]
value
OneOf
IdpHost
object (IdpHost)
source
string Required
Application host source
Valid values[
"idp"
]
value
string Required
Application host value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
port
OneOf
FixedPort
object (FixedPort)
source
string Required
Application port source
Valid values[
"fixed"
]
value
Example443
IdpPort
object (IdpPort)
source
string Required
Application port source
Valid values[
"idp"
]
value
string Required
Application port value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
users
Array of string (AlphanumericWithSpace)
List of IDs of assigned users. To get the IDs use endpoint '/users' with [user:read] permission.
Min items1
Example[
"mWKM26JMc1",
"mWKM26JMc2"
]
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
object
object
headers
object Required
Application specific headers. Keys must not contain . and $
Pattern^[^.$]+$
Example{
"X-Custom-Header": "value"
}
attributes
object Required
checkStatus
integer
Default200
checkPath
string
Default""
ExamplecheckPath
startRelativePath
string
Default""
Pattern^$|^\/[\w\d-._~!$&'()*+,;=:@/?#%]+$
Example/startRelativePath
sslCertificateVerification
boolean
Defaulttrue
OneOf
object
object
users
Array Required
name
string
Application name
Min length5
Max length32
Pattern^[^~`()!#$%^&*+=[]\';,/{}|":<>?№@]+$
ExampleMyApplication
type
string
Application type
Valid values[
"http",
"https",
"rdp"
]
network
ExampleZwAeo5wqiF
host
OneOf
FixedHost
object (FixedHost)
source
string Required
Application host source
Valid values[
"fixed"
]
value
OneOf
IdpHost
object (IdpHost)
source
string Required
Application host source
Valid values[
"idp"
]
value
string Required
Application host value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
port
OneOf
FixedPort
object (FixedPort)
source
string Required
Application port source
Valid values[
"fixed"
]
value
Example443
IdpPort
object (IdpPort)
source
string Required
Application port source
Valid values[
"idp"
]
value
string Required
Application port value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
groups
Array of string (AlphanumericWithSpace)
List of IDs of assigned groups. To get the IDs use endpoint '/groups' with [group:read] permission.
Min items1
Example[
"mWKM26JMc1",
"mWKM26JMc2"
]
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
object
object
groups
Array Required
name
string
Application name
Min length5
Max length32
Pattern^[^~`()!#$%^&*+=[]\';,/{}|":<>?№@]+$
ExampleMyApplication
type
string
Application type
Valid values[
"http",
"https",
"rdp"
]
network
ExampleZwAeo5wqiF
host
OneOf
FixedHost
object (FixedHost)
source
string Required
Application host source
Valid values[
"fixed"
]
value
OneOf
IdpHost
object (IdpHost)
source
string Required
Application host source
Valid values[
"idp"
]
value
string Required
Application host value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
port
OneOf
FixedPort
object (FixedPort)
source
string Required
Application port source
Valid values[
"fixed"
]
value
Example443
IdpPort
object (IdpPort)
source
string Required
Application port source
Valid values[
"idp"
]
value
string Required
Application port value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
users
Array of string (AlphanumericWithSpace)
List of IDs of assigned users. To get the IDs use endpoint '/users' with [user:read] permission.
Min items1
Example[
"mWKM26JMc1",
"mWKM26JMc2"
]
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
object
object
attributes
object (RdpAttributes) Required
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
auth
object (ApplicationAuth) Required
Authentication settings related to the application
authEnabled
boolean Required
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
OneOf
object
object
users
Array Required
name
string
Application name
Min length5
Max length32
Pattern^[^~`()!#$%^&*+=[]\';,/{}|":<>?№@]+$
ExampleMyApplication
type
string
Application type
Valid values[
"http",
"https",
"rdp"
]
network
ExampleZwAeo5wqiF
host
OneOf
FixedHost
object (FixedHost)
source
string Required
Application host source
Valid values[
"fixed"
]
value
OneOf
IdpHost
object (IdpHost)
source
string Required
Application host source
Valid values[
"idp"
]
value
string Required
Application host value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
port
OneOf
FixedPort
object (FixedPort)
source
string Required
Application port source
Valid values[
"fixed"
]
value
Example443
IdpPort
object (IdpPort)
source
string Required
Application port source
Valid values[
"idp"
]
value
string Required
Application port value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
groups
Array of string (AlphanumericWithSpace)
List of IDs of assigned groups. To get the IDs use endpoint '/groups' with [group:read] permission.
Min items1
Example[
"mWKM26JMc1",
"mWKM26JMc2"
]
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
object
object
groups
Array Required
name
string
Application name
Min length5
Max length32
Pattern^[^~`()!#$%^&*+=[]\';,/{}|":<>?№@]+$
ExampleMyApplication
type
string
Application type
Valid values[
"http",
"https",
"rdp"
]
network
ExampleZwAeo5wqiF
host
OneOf
FixedHost
object (FixedHost)
source
string Required
Application host source
Valid values[
"fixed"
]
value
OneOf
IdpHost
object (IdpHost)
source
string Required
Application host source
Valid values[
"idp"
]
value
string Required
Application host value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
port
OneOf
FixedPort
object (FixedPort)
source
string Required
Application port source
Valid values[
"fixed"
]
value
Example443
IdpPort
object (IdpPort)
source
string Required
Application port source
Valid values[
"idp"
]
value
string Required
Application port value
Pattern^[a-zA-Z0-9_.-]{2,255}$
ExampleidpExample
users
Array of string (AlphanumericWithSpace)
List of IDs of assigned users. To get the IDs use endpoint '/users' with [user:read] permission.
Min items1
Example[
"mWKM26JMc1",
"mWKM26JMc2"
]
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
Responses
202
Application created successfully
object
statusUrl
string
samplingTime
integer
400
Bad Request
401
Not Authorized
403
Forbidden
500
Internal Server Error
Was this article helpful?