Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

List machines

List filters are passed as query parameters — see the conventions in the introduction.

GET/machine
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Responses
200

OK.

Array of Machine
idstring

Machine ID (autoassigned, read-only)

appIdstring

Application ID (autoassigned, read-only)

machineGroupIdstring

Machine group ID (create-only, not updatable)

customIdstring

Custom identifier

namestring

Machine name

isEnabledboolean

Whether the machine is enabled (read-only)

groupPropertiesobject

Machine group properties, Property Name to Value mapping (read-only)

propertiesobject

Object with Property Name to Value mapping

createdAtstring

Creation date (ISO date, autoassigned, read-only)

401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/machine' \
  -H 'Authorization: YOUR_API_KEY'
Response
[
  {
    "id": "165",
    "machineGroupId": "246",
    "appId": "1677",
    "customId": "MG-0002-001",
    "name": "Machine 001",
    "isEnabled": true,
    "groupProperties": {
      "Custom Property": "Custom Value 5",
      "Property2": "value 5"
    },
    "properties": {
      "Property2": "Machine Property"
    },
    "createdAt": "2022-07-01T17:49:27.652Z"
  }
]