Skip to content
aYOUne
← Configuration API

IoTDevices

Singular: IoTDevice — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "device": {
      "stats": {
        "netstat": [],
        "inOut": []
      },
      "maintenanceForecast": {
        "reasons": []
      },
      "_id": "6aa76eac8e4d941dde87f0fc",
      "active": true,
      "capabilities": [],
      "status": "offline",
      "factoryNotes": "GLAD_TAN_C-3PO",
      "factoryTestResults": [],
      "createdBy": "6045f4d25704710012485569",
      "last_active": "2026-09-14T03:49:00.333Z",
      "values": [],
      "shares": [],
      "createdAt": "2026-09-14T03:49:00.334Z",
      "updatedAt": "2026-10-08T10:56:38.347Z",
      "offlineSince": "2026-09-14T03:54:21.878Z",
      "_companyLocation": null,
      "modifiedBy": "5a76d07e2d8b3270ff6df587",
      "_buildingSpace": null
    },
    "history": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://iot.ayoune.app/iotdevices/6aa76eac8e4d941dde87f0fc",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "CompanyLocations",
        "title": "MODEL_COMPANYLOCATION",
        "href": "https://api.ayoune.app/config/companylocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.companylocations"
      },
      {
        "rel": "StorageAreas",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/warehouse/storageareas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "warehouse.storageareas"
      },
      {
        "rel": "BuildingSpaces",
        "title": "MODEL_BUILDINGSPACE",
        "href": "https://api.ayoune.app/config/buildingspaces",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.buildingspaces"
      },
      {
        "rel": "aYOUneAdvertisementDisplayLocations",
        "title": "MODEL_AYOUNEADVERTISEMENTDISPLAYLOCATION",
        "href": "https://api.ayoune.app/su/ayouneadvertisementdisplaylocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.ayouneadvertisementdisplaylocations"
      },
      {
        "rel": "Departments",
        "title": "MODEL_DEPARTMENT",
        "href": "https://api.ayoune.app/config/departments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.departments"
      },
      {
        "rel": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      },
      {
        "rel": "Machines",
        "title": "MODEL_MACHINE",
        "href": "https://api.ayoune.app/config/machines",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.machines"
      },
      {
        "rel": "WallBoards",
        "title": "MODEL_WALLBOARD",
        "href": "https://api.ayoune.app/pm/wallboards",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.wallboards"
      },
      {
        "rel": "Credentials",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.credentials"
      },
      {
        "rel": "IoTDeviceBlueprints",
        "title": "MODEL_IOTDEVICEBLUEPRINT",
        "href": "https://api.ayoune.app/iot/iotdeviceblueprints",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "iot.iotdeviceblueprints"
      },
      {
        "rel": "IoTDevices",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.iotdevices"
      }
    ],
    "debugId": "6adecaadc2252ba8951b7210",
    "errors": [],
    "actions": [],
    "version": {
      "host": "2026.46.0",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9997",
      "reset": "1792989373",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 38.65311,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /iotdevices List with filters/pagination config.iotdevices.view
GET /iotdevices/:id Single record config.iotdevices.view
POST /iotdevices Create new record config.iotdevices.new
PUT /iotdevices Update record config.iotdevices.edit
DELETE /iotdevices/:id Delete record config.iotdevices.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.ioTDevices.find().limit(10).exec();

// Single record
const one = await ay.config.ioTDevices.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.ioTDevices.create({ name: 'Foo' });

See also