openapi: 3.2.0
info:
description: 'API definition for CRUD operations on devices. A device is the physical hardware that can be either:
- a gateway - makes information available to the Glow Platform. The IHD/CAD and GlowSticks are examples of our gateways.
- a sensor - detects events or changes to its environment and sends information to other devices (smart electricity meter)
- an actuator - a controller, given specific predefined commands it can trigger events, change its environment or perform an operation (auxiliary load control switch in an electricity meter)
'
version: 1.1.0
title: Device Management System Discover API
license:
name: Copyright © 2012-26 by Hildebrand Technology Limited
servers:
- url: https://api.glowmarkt.com/api/v0-1/
tags:
- name: discover
paths:
/discover/{hardwareId}:
get:
tags:
- discover
summary: Find device by ID
description: Returns the devices and if they do not exist the assets and product types
operationId: discoverDevicesAssets
parameters:
- name: hardwareId
in: path
description: A hardware identifier of a Device. For a network device, we typically use the MAC address.
required: true
schema:
type: string
security:
- userToken: []
applicationId: []
- appKeys: []
userId: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ''
'404':
description: Not Found
content:
application/json:
schema:
$ref: ''
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
components:
schemas:
ServerError:
type: object
properties:
error:
type: string
example: An error has occurred
xml:
name: AddResourceError
securitySchemes:
orgAppKeys:
type: http
scheme: basic
appKeys:
type: http
scheme: basic
devUserToken:
type: apiKey
name: token
in: header
userToken:
type: apiKey
name: token
in: header
applicationId:
type: apiKey
name: applicationId
in: header
userId:
type: apiKey
name: userId
in: header