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

Create a machine

POST/machine
Authorization
AuthorizationAPI key · headerrequired

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

Request body
application/json
namestringrequired

Machine name.

customIdstringrequired

Custom machine id.

machineGroupIdintegerrequired

Id of the machine group.

propertiesobjectrequired

Machine properties.

Responses
200

Created. Returns only the id — fetch the full Machine with the corresponding GET.

idinteger | stringrequired

Id of the created Machine.

Show properties
One of:
integer
integer
string
string
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
Bodyapplication/json
Request
curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/machine' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "customId": "string",
  "machineGroupId": 0,
  "properties": {}
}'
Response
{
  "id": 0
}