Get rule pause settings

Get the current and planned rule pause details

POST /api/rules/getRulePauseSettings

Get rule pause settings

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/rules/getRulePauseSettings \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "rulesPausedMap": {},
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting rule pause settings.

Response

200 - application/json

OK

Response object for getting rule pause settings.

error · boolean | null

errorMsg · string | null

rulesPausedMap · object

Map of rule UUIDs to their pause settings

Show child attributes

warningMsg · string | null