Failure detection API - GET a detection rule

Gets the specified failure detection rule.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules/{id}
  • SaaS https://{your-environment-id}{id}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules/{id}


To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
id string

The ID of the required failure detection rule.

path required


To find all model variations that depend on the type of the model, see JSON models.

Response codes

Code Description



Failed. The specified entity doesn't exist.

Response body

The FailureDetectionRule object

Configuration of the failure detection rule.

Element Type Description
id string

The ID of the rule.

The allowed characters are lowercase and uppercase letters, numbers, hyphens (-), and underscores (_). The length is limited to30 characters.

name string

The display name of the rule.

The length of the name is limited to 150 characters.

description string

A short description of the rule.

enabled boolean

The rule is enabled (true) or disabled (false).

fdpId string

The failure detection parameter (FDP) set of the rule.

Specify the ID of the set here. The FDP set must exist at the time of rule creation.

conditions FailureDetectionCondition[]

A list of conditions of the rule.

The rule applies when all conditions are fulfilled.

The FailureDetectionCondition object

The condition of the failure detection rule.

Element Type Description
attribute string

The attribute to be checked.

predicate FdcPredicate

The FdcPredicate object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll