Skip to content

Get Machines

Retrieves a set of machines.

Verb POST
Endpoint {base-url}/machines/settings
Max Page Size 1000

Request Body

{
  "requestFilter": {
    "organizationIds": [1],
    "accountIds": [49],
    "siteIds": [7],
    "machineIdentifiers": ["PROSE1234567890"],
    "includeDeleted": false
  },
  "routeFilter": {
    "includeInactive": false,
    "groupIds": [7],
    "settingsIds": [1]
  }
}

Filters Honored

  • RequestFilter
    • organizationIds
    • accountIds
    • siteIds
    • machineIdentifiers
    • includeDeleted
  • SettingsFilter
    • includeInactive
    • groupIds
    • settingsIds

Returns

On Success

The requested list of settings.

Response Body

[
  {
    "id": 1, // do not include for records being created
    "machineId": 1166,
    "settings": "arsarsa 3: the harrowing",
    "isActive": true,
    "isCurrent": true,
    "type": "asairens",
    "createdAt": "2023-08-07T02:44:14.887"
  }
]