List machines by proximity

POST/machine/by-proximity

Authorization

AuthorizationAPI key · headerrequired

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

Request body

application/json

idstring

Platform machine id to measure proximity from. Alternative to customId.

customIdstring

Custom machine id to measure proximity from. Alternative to id.

limitinteger

Maximum number of machines to return.

machineIdsstring[]

Restrict the candidate machines. Platform machine ids as strings.

Responses

200

Created.

Array of object

object

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/machine/by-proximity' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "string",
  "customId": "string",
  "limit": 0,
  "machineIds": [
    "string"
  ]
}'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/machine/by-proximity", {
  method: "POST",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"id\": \"string\",\n  \"customId\": \"string\",\n  \"limit\": 0,\n  \"machineIds\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://next.amfg.ai/engine-service/public-api/v1/machine/by-proximity",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"id\": \"string\",\n  \"customId\": \"string\",\n  \"limit\": 0,\n  \"machineIds\": [\n    \"string\"\n  ]\n}",
)

Response

[
  {}
]

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}