Skip to main content
POST
/
api
/
report
/
getEnvoyLocations
Get Envoy locations
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getEnvoyLocations \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "authError": true,
  "error": true,
  "errorMsg": "<string>",
  "locationList": [
    {
      "id": 123,
      "name": "<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

The body is of type object.

Response

200 - application/json

OK

authError
boolean | null
error
boolean | null
errorMsg
string | null
locationList
object[] | null
warningMsg
string | null