Skip to main content
POST
/
api
/
rules
/
pauseRule
Pause rule
curl --request POST \
  --url https://api2.rhombussystems.com/api/rules/pauseRule \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "durationSec": 3600,
  "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "scheduledTimestampSec": 1640995200
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for pausing a rule.

​
durationSec
integer<int64> | null

Duration to pause the rule in seconds

Example:

3600

​
ruleUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
scheduledTimestampSec
integer<int64> | null

Scheduled timestamp in seconds when the pause should take effect

Example:

1640995200

Response

200 - application/json

OK

Response object for pausing a rule.

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null