Add a new application

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Add a new private access application. An application is defined by a domain (FQDN) and port combination.

Endpoints

Request URL

https://{server-hostname}:8383/sse/api/applications

Scope

SSE.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
namestringOptional

Display name for the application. Must match regex [a-zA-Z0-9 .-\t]+. Required

typestringOptional

Application type identifier. Required

FQDNJSON ObjectOptional

Nested object containing the FQDN, port, and protocol of the protected application. Required

Show Sub-Attributes
fqdnstringOptional

Fully qualified domain name of the protected application. Required

portstringOptional

Port number the application is accessible on (0-65535). Required

protocolstringOptional

Transport protocol: TCP or UDP. Defaults to TCP if not specified

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/sse/api/applications \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"FQDN":{"protocol":"TCP","fqdn":"portal.internal.company.com","port":443},"name":"Internal Portal","type":1}'

Sample Request Body

Create a new TCP application with FQDN, port, and protocol

Copied!
  {
    "FQDN": {
      "protocol": "TCP",
      "fqdn": "portal.internal.company.com",
      "port": 443
    },
    "name": "Internal Portal",
    "type": 1
  }
                
Show full

Create a new UDP application

Copied!
  {
    "FQDN": {
      "protocol": "UDP",
      "fqdn": "dns.internal.company.com",
      "port": 53
    },
    "name": "DNS Server",
    "type": 1
  }
                
Show full

Response Parameters

- HTTP code 201

Response Body - application/json
JSON Object
Hide Sub-Attributes
applicationIDlong

The unique identifier (auto-generated primary key) of the newly created application

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Application-specific error code. Possible codes: API_APPLICATION_004 (maximum 1000 application limit reached), API_APPLICATION_005 (application with same name already exists), API_APPLICATION_006 (application with same FQDN, port and protocol already exists), API_APPLICATION_001 (service-layer duplicate detection), API_APPLICATION_002 (unknown error while adding application)

errorMsgstring

Detailed error message describing the specific application creation failure

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

Possible Response Codes

201HTTP code
400HTTP code
401HTTP code
403HTTP code

Sample Response: HTTP 201

Application created successfully — returns the auto-generated application ID

Copied!
  {
    "applicationID": 2001
  }
                
Show full

Sample Response: HTTP 400

The tenant has reached the maximum limit of 1000 applications

Copied!
  {
    "errorCode": "API_APPLICATION_004",
    "errorMsg": "You are allowed to add only up to 1000 Applications"
  }
                
Show full

An application with the same name already exists in this tenant

Copied!
  {
    "errorCode": "API_APPLICATION_005",
    "errorMsg": "An Application with the same name already exists."
  }
                
Show full

An application with the same FQDN, port, and protocol combination already exists

Copied!
  {
    "errorCode": "API_APPLICATION_006",
    "errorMsg": "An Application with the same FQDN, port and protocol already exists."
  }
                
Show full

An unexpected error occurred during application creation

Copied!
  {
    "errorCode": "API_APPLICATION_002",
    "errorMsg": "Unknown error while adding application."
  }
                
Show full

Sample Response: HTTP 401

Authentication credentials are missing or invalid

Copied!
  {
    "errorMessage": "You are not authorized to perform this action",
    "errorCode": "UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 403

User does not have the required SSE_Write role

Copied!
  {
    "errorMessage": "User does not have permission to perform this operation",
    "errorCode": "FORBIDDEN"
  }
                
Show full