Applications detection rules API - GET a rule

Gets parameters of the specified application detection rule.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/{id} SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/applicationDetectionRules/{id}

Authentication

To execute this request, you need the Read configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the application detection rule you're inquiring.	path	required

Response format

Response parameters JSON model

The ApplicationDetectionRuleConfig object

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging.
id	string	The unique ID of the rule. When adding a new rule, you can either specify your own ID, or don't specify anything, in that case the ID will be generated automatically.
order	string	The order string. Sorting application detection rules alphabetically by their order string determines their relative ordering. Typically this is managed by DESK internally and will not be present in GET responses.
applicationIdentifier	string	The identifier of the application, for example `APPLICATION-4A3B43`. You must use an existing ID.
filterConfig	ApplicationFilter	Defines how to identify an application.

The ApplicationFilter object

Defines how to identify an application.

Element	Type	Description
pattern	string	The string to look for.
applicationMatchType	string	Defines the matching rule.
applicationMatchTarget	string	Defines where to look for the string.

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.
clusterVersion	string	DESK server version.

    
{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": {
      "major": 0,
      "minor": 0,
      "revision": 0,
      "sourceRevision": "",
      "timestamp": ""
    }
  },
  "id": "12345678-abcd-1234-abcd-1234567890ab",
  "applicationIdentifier": "APPLICATION-123456",
  "filterConfig": {
    "pattern": "myapp.example.com",
    "applicationMatchType": "EQUALS",
    "applicationMatchTarget": "DOMAIN"
  }
}