Skip to main content
POST
/
api
/
climate
/
deleteEnvironmentalGateway
Delete environmental gateway
curl --request POST \
  --url https://api2.rhombussystems.com/api/climate/deleteEnvironmentalGateway \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "mummify": false
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "responseStatus": "BASIC_AUTH_FAILED",
  "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 to delete an environmental gateway.

​
deviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
mummify
boolean | null

Whether to mummify the gateway instead of deleting it

Example:

false

Response

200 - application/json

OK

Response indicating the result of deleting an environmental gateway.

​
error
boolean | null
​
errorMsg
string | null
​
responseStatus
enum<string> | null

Status of the delete operation

Available options:
BASIC_AUTH_FAILED,
PASSWORD_MISMATCH,
SAME_PASSWORD,
USER_EXISTS,
USER_NOT_FOUND,
DEVICE_NOT_FOUND,
POLICY_NOT_FOUND,
LOCATION_NOT_FOUND,
ORG_NOT_FOUND,
BAD_INPUT,
SUCCESS,
PASSWORD_TOO_SHORT
​
warningMsg
string | null