Applications detection rules API - PUT a rule

Updates the specified application detection rule.

The request consumes and produces an application/json payload.

PUT	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 Write 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 to update. The ID of the application detection rule in the body of the request, if given, must match this ID.	path	required
body	ApplicationDetectionRuleConfig	JSON body of the request containing updated definition of the application detection rule. If order is present, it will be used.	body	optional

Parameter

Type

Description

Required

string

The ID of the application detection rule to update.

The ID of the application detection rule in the body of the request, if given, must match this ID.

path

required

body

ApplicationDetectionRuleConfig

JSON body of the request containing updated definition of the application detection rule. If order is present, it will be used.

body

optional

Request parameters JSON model

The ApplicationDetectionRuleConfig object

Element	Type	Description	Required
metadata	ConfigurationMetadata	Metadata useful for debugging.	optional
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.	optional
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.	optional
applicationIdentifier	string	The identifier of the application, for example `APPLICATION-4A3B43`. You must use an existing ID.	required
filterConfig	ApplicationFilter	Defines how to identify an application.	required

The ApplicationFilter object

Defines how to identify an application.

Element	Type	Description	Required
pattern	string	The string to look for.	required
applicationMatchType	string	Defines the matching rule. The applicationMatchType element can hold these values.	required
applicationMatchTarget	string	Defines where to look for the string. The applicationMatchTarget element can hold these values.	required

The ConfigurationMetadata object

Metadata useful for debugging

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

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "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"
  }
}

Possible values

Possible values for the applicationMatchTarget element in the ApplicationFilter object:

DOMAIN
URL

Possible values for the applicationMatchType element in the ApplicationFilter object:

BEGINS_WITH
CONTAINS
ENDS_WITH
EQUALS
MATCHES

Response format

Response parameters JSON model

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description
id	string	The ID of the DESK entity.
name	string	The name of the DESK entity.
description	string	A short description of the DESK entity.

{}

Response codes

Code	Description
201	Success. Application detection rule has been created. The new rule's ID and name will be returned.
204	Success. Application detection rule has been updated. Response doesn't have a body.
400	Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

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

Authentication

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

Response codes

Code	Description
204	Validated. The submitted configuration is valid. Response does not have a body.
400	Failed. The input is invalid.