response format for SetGateway MIM API endpoint

luckman212

Hey guys
I was able to figure out how to update the monitor IP of a gateway using PUT directed at the /system/gateways/{id} endpoint. It works!

The response I get is shaped like this

{
  "msg": "Gateway updated",
  "alrt": false,
  "sb": false,
  "alrtoln": false,
  "alrtclr": "",
  "auth": false,
  "status": "",
  "result": ""
}

My question is: how do we interpret these keys/values?

I assume Gateway updated indicates success. But a boolean is more typical for an API "success" response.

Do any of those bools (sb, alrt, alrtoln etc) mean the op was successful ?

luckman212

I peeked in at pfsense_result.py on the pfsense-api GitHub repo, which seems to be where the result class is defined. But, it didn't reveal anything further.

marcosm

They're mainly there for some GUI compatibility; it may get updated in the future. E.g. the alrt attributes are meant to be alert outline and color. Go off of what msg says.

luckman212

Thanks. If the API is still being worked on, it would be nicer to have a strict success: true | false bool for automation vs parsing a text field.