Skip to main content
POST
/
api
/
policy
/
getPolicyPauseSettings
Get policy pause settings
curl --request POST \
  --url https://api2.rhombussystems.com/api/policy/getPolicyPauseSettings \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "policiesPausedForComponentCompositesMap": {},
  "policiesPausedForDevicesMap": {},
  "policiesPausedForLocationsMap": {},
  "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 policy pause settings.

Response

200 - application/json

OK

Response object containing policy pause settings for locations, devices, and component composites.

​
error
boolean | null
​
errorMsg
string | null
​
policiesPausedForComponentCompositesMap
object

Map of component composite UUIDs to their paused policy scheduled intervals

​
policiesPausedForDevicesMap
object

Map of device UUIDs to their paused policy scheduled intervals

​
policiesPausedForLocationsMap
object

Map of location UUIDs to their paused policy scheduled intervals

​
warningMsg
string | null
Last modified on June 6, 2026