Retrieve all applications

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

Retrieve the list of all applications configured for the tenant, including their FQDN, port, and status details.

Endpoints

Request URL

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

Scope

SSE.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/sse/api/applications \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

The unique identifier (primary key) of the application

namestring

The display name of the application

typestring

The application type (may be null in GET response)

statusstring

Application status as string: 1 = Active, 2 = Inactive

addedTimelong

Timestamp (epoch milliseconds) when the application was created

addedBylong

User ID of the administrator who created the application

FQDNJSON Object

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

Show Sub-Attributes
fqdnstring

The fully qualified domain name of the protected application

portstring

Port number the application is accessible on

protocolstring

Transport protocol: TCP or UDP

- 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

200HTTP code
401HTTP code
403HTTP code

Sample Response: HTTP 200

List of all applications configured for the tenant

Copied!
  [
    {
      "FQDN": {
        "protocol": "TCP",
        "fqdn": "portal.internal.company.com",
        "port": 443
      },
      "addedBy": 2,
      "name": "Internal Portal",
      "addedTime": 1711180800000,
      "applicationId": 2001,
      "type": null,
      "status": "1"
    },
    {
      "FQDN": {
        "protocol": "UDP",
        "fqdn": "dns.internal.company.com",
        "port": 53
      },
      "addedBy": 2,
      "name": "DNS Server",
      "addedTime": 1711180800000,
      "applicationId": 2002,
      "type": null,
      "status": "1"
    }
  ]
                
Show full

No applications configured for the tenant

Copied!
  []
                
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_Read role

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