Ayla Networks Devices.json API
The Devices.json API from Ayla Networks — 1 operation(s) for devices.json.
The Devices.json API from Ayla Networks — 1 operation(s) for devices.json.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ayla-networks:ayla-networks-devices-json-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: device-service Devices.json API
version: '1.0'
servers:
- url: https://ads-dev.aylanetworks.com/apiv1/
security:
- sec0: []
tags:
- name: Devices.json
paths:
/devices.json:
post:
summary: Register device
description: This API registers the specified device to the caller.
operationId: register-device
requestBody:
content:
application/json:
schema:
type: object
properties:
device:
properties:
dsn:
type: string
description: Device serial number. This parameter is required for all types except for “Display” and “AP-Mode".
regtoken:
type: string
description: Registration token obtained from the device. This parameter is required for “Same-LAN” and “Display” registration type, optional in other cases.
setup_token:
type: string
description: Setup token generated by application. This parameter is required only for "AP-Mode" registration type, optional in other cases.
ip:
type: string
description: Public IP address of the device to be registered.
lat:
type: string
description: Latitude of the device.
lng:
type: string
description: Longitude of the device.
required: []
type: object
description: Device object.
examples: {}
responses:
'201':
content:
application/json:
schema:
type: object
properties:
device:
type: object
properties:
id:
type: integer
example: 7433523
default: 0
product_name:
type: string
example: ESP32 demo
model:
type: string
example: AY008ESP1
dsn:
type: string
example: AC000W041714026
oem:
type: string
example: 0dfc7900
oem_model:
type: string
example: demo-esp32
connect_path:
type: string
unique_hardware_id:
type: string
hwsig:
type: string
example: mac-b0a732c80dd0
sw_version:
type: string
example: ADA 3.0.10-eng ecr6600-ECR6600F_V0.0.1B01 2026-03-02 17:21:52 edward/module/177c85866b
user_id:
type: integer
example: 101010
default: 0
user_uuid:
type: string
example: 63d92ce0-0118-11e6-9b1b-0ab3f06930bb
template_id:
type: integer
example: 251412
default: 0
mac:
type: string
example: '000606000000'
imei:
type: string
ip:
type: string
example: 113.88.88.19
lan_ip:
type: string
example: 192.168.3.102
ssid:
type: string
example: '332404'
connected_at:
type: string
example: '2026-04-12T15:26:12Z'
key:
type: integer
example: 7433523
default: 0
product_class:
type: string
example: demo
has_properties:
type: boolean
example: true
default: true
lan_enabled:
type: boolean
example: true
default: true
connection_priority:
type: array
items:
type: string
example: LAN
enable_ssl:
type: string
enable_ip_loc:
type: boolean
example: true
default: true
enable_wifi_loc:
type: boolean
example: false
default: true
ans_enabled:
type: boolean
example: false
default: true
ans_server:
type: string
example: ans-dev.aylanetworks.com
log_enabled:
type: boolean
example: false
default: true
registered:
type: boolean
example: true
default: true
connection_status:
type: string
example: Offline
registration_type:
type: string
example: AP-Mode
lat:
type: string
example: '12.9753'
lng:
type: string
example: '77.591'
locality:
type: string
homekit:
type: string
enable_setup_loc:
type: boolean
example: true
default: true
force_location:
type: boolean
example: false
default: true
module_updated_at:
type: string
example: '2026-03-14T08:29:47Z'
registrable:
type: boolean
example: true
default: true
regtoken:
type: string
device_type:
type: string
example: Wifi
provisional:
type: boolean
example: false
default: true
activated_at:
type: string
example: '2025-09-14T03:05:31Z'
setup_token:
type: string
example: FNWZRZp
created_at:
type: string
example: '2025-09-14T03:05:31Z'
last_get_at:
type: string
example: '2026-04-12T15:26:12Z'
address:
type: string
dealer:
type: string
facility_uuid:
type: string
examples:
Created:
summary: Created
value:
device:
id: 7433523
product_name: ESP32 demo
model: AY008ESP1
dsn: AC000W041714026
oem: 0dfc7900
oem_model: demo-esp32
connect_path: null
unique_hardware_id: null
hwsig: mac-b0a732c80dd0
sw_version: ADA 3.0.10-eng ecr6600-ECR6600F_V0.0.1B01 2026-03-02 17:21:52 edward/module/177c85866b
user_id: 101010
user_uuid: 63d92ce0-0118-11e6-9b1b-0ab3f06930bb
template_id: 251412
mac: '000606000000'
imei: null
ip: 113.88.88.19
lan_ip: 192.168.3.102
ssid: '332404'
connected_at: '2026-04-12T15:26:12Z'
key: 7433523
product_class: demo
has_properties: true
lan_enabled: true
connection_priority:
- LAN
enable_ssl: null
enable_ip_loc: true
enable_wifi_loc: false
ans_enabled: false
ans_server: ans-dev.aylanetworks.com
log_enabled: false
registered: true
connection_status: Offline
registration_type: AP-Mode
lat: '12.9753'
lng: '77.591'
locality: null
homekit: null
enable_setup_loc: true
force_location: false
module_updated_at: '2026-03-14T08:29:47Z'
registrable: true
regtoken: null
device_type: Wifi
provisional: false
activated_at: '2025-09-14T03:05:31Z'
setup_token: FNWZRZp
created_at: '2025-09-14T03:05:31Z'
last_get_at: '2026-04-12T15:26:12Z'
address: null
dealer: null
facility_uuid: null
description: Created
'401':
content: {}
description: Unauthorized
'403':
content: {}
description: Forbidden
'404':
content: {}
description: Not Found
'422':
content: {}
description: Unprocessable Entity
deprecated: false
tags:
- Devices.json
get:
summary: Get devices
description: 'This API returns an array of device objects.This API returns an array of device objects in one of two formats depending on whether you include the paginated query parameter. If the `paginated` parameter is not passed, the API returns data using Format A, and heeds the other query parameters, most notably order_by, order, and user_uuid:**Format A**
{ "previous_page": null, "next_page": 2, "current_page_number": 1, "start_count_on_page": 1, "end_count_on_page": 5, "total": 9, "devices": [ { "device": {} }, { "device": {} } ]}
If the `paginated` parameter is not passed, the API returns data using Format B, data that includes only devices owned by or shared with the caller, and ignores the other query parameters including order_by:**Format B**
[ { "device": {} }, { "device": {} }]
In general, paginated=1 is recommended because you can control quantity (per_page) and order (order_by).**NOTE**:The presence of the `connection_priority` key in the response body is based on the below conditions on query parameters.* If (paginated = true) or (paginated = false & only_dsns = false & dsns_list = false & show_optimal = false), then the `connection_priority` key will be present in the response body.* If (paginated = false) & (only_dsns = true or dsns_list = true or show_optimal = true), then the `connection_priority` key will not be present in the response body.'
operationId: get-associated-devices
parameters:
- name: paginated
in: query
description: true or 1 means results will be paginated.
schema:
type: boolean
- name: page
in: query
description: Page Number.
schema:
type: string
- name: per_page
in: query
description: Maximum number of records per page.
schema:
type: string
- name: order_by
in: query
description: Field name. Based on this value, the result will be sorted.
schema:
type: string
- name: order
in: query
description: Ascending (asc) or descending (desc).
schema:
type: string
- name: user_uuid
in: query
description: Unique user identifier.
schema:
type: string
- name: connected_at_after
in: query
description: Connected on or after this date.
schema:
type: string
- name: connected_at_before
in: query
description: Connected on or before this date.
schema:
type: string
- name: activated_at_after
in: query
description: Activated on or after this date.
schema:
type: string
- name: activated_at_before
in: query
description: Activated on or before this date.
schema:
type: string
- name: status
in: query
description: 'Device status: online, offline, or initializing.'
schema:
type: string
- name: virtual
in: query
description: to get virtual devices list, select "true".
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
anyOf:
- type: object
properties:
previous_page:
type: string
next_page:
type: integer
example: 2
default: 0
current_page_number:
type: integer
example: 1
default: 0
start_count_on_page:
type: integer
example: 1
default: 0
end_count_on_page:
type: integer
example: 100
default: 0
total:
type: integer
example: 445568
default: 0
devices:
type: array
items:
type: object
properties:
device:
type: object
properties:
product_name:
type: string
example: AC000W000000003
model:
type: string
example: AY001MTP2
dsn:
type: string
example: AC000W000000003
unique_hardware_id:
type: string
oem_model:
type: string
example: '12'
sw_version:
type: string
example: bc 0.5 09/18/11 11:20:56 ID jre/not/eb2617e+
mac:
type: string
lan_ip:
type: string
example: 192.168.2.101
connected_at:
type: string
example: '2014-04-02T18:26:20Z'
key:
type: integer
example: 3
default: 0
lan_enabled:
type: boolean
example: true
default: true
connection_priority:
type: array
items:
type: string
example: LAN
registered:
type: boolean
example: false
default: true
user_id:
type: string
user_uuid:
type: string
template_id:
type: string
connection_status:
type: string
lat:
type: string
example: '37.3486'
lng:
type: string
example: '-121.951'
locality:
type: string
example: '95050'
homekit:
type: string
oem_id:
type: string
example: '12'
dealer:
type: string
facility_uuid:
type: string
imei:
type: string
transport_type:
type: string
title: Eample Response When Pagination = True
- type: object
properties:
Devices:
type: object
properties:
product_name:
type: string
dsn:
type: string
sw_version:
type: string
ip:
type: string
connected_at:
type: string
user_id:
type: string
user_uuid:
type: string
lat:
type: string
lng:
type: string
locality:
type: string
homekit:
type: string
dealer:
type: string
facility_uuid:
type: string
transport_type:
type: string
title: Eample Response When Pagination = False
examples:
Example response when pagination = True:
summary: Example response when pagination = True
value: "{\n \"previous_page\": null,\n \"next_page\": 2,\n \"current_page_number\": 1,\n \"start_count_on_page\": 1,\n \"end_count_on_page\": 100,\n \"total\": 445568,\n \"devices\": [\n {\n \"device\": {\n \"product_name\": \"product_name\",\n \"model\": \"AY001MSL1\",\n \"dsn\": \"TESTDSN_6705023_000\",\n \"oem_model\": \"ledevb-test\",\n \"sw_version\": \"1.0\",\n \"template_id\": 625159,\n \"mac\": \"8a:8b:2b:15:6a:b4\",\n \"unique_hardware_id\": \"a8:02:c4:22:0c:31\",\n \"hwsig\": \"fypfhheq823zbxavwqt911\",\n \"lan_ip\": null,\n \"connected_at\": \"2026-06-08T17:20:01Z\",\n \"key\": 7559190,\n \"lan_enabled\": false,\n \"connection_priority\": [],\n \"has_properties\": true,\n \"product_class\": \"product_class\",\n \"connection_status\": \"Offline\",\n \"lat\": \"39.0469\",\n \"lng\": \"-77.4903\",\n \"locality\": \"20149\",\n \"device_type\": \"Wifi\",\n \"dealer\": null,\n \"facility_uuid\": null,\n \"manuf_model\": \"test_mfg_model\",\n \"oem\": \"0dfc7900\",\n \"transport_type\": \"mqtt-native\"\n }\n }\n }\n },\n {\n \"device\": {\n \"product_name\": null,\n \"model\": \"AY001MTP1\",\n \"dsn\": \"AC000W000000007\",\n \"unique_hardware_id\": null,\n \"oem_model\": null,\n \"sw_version\": \"bc 0.7 10/05/11 17:58:18 ID jre/canary/52689fa+\",\n \"mac\": null,\n \"lan_ip\": \"172.31.0.137\",\n \"connected_at\": \"2011-10-07T18:18:11Z\",\n \"key\": 8,\n \"lan_enabled\": false,\n \"connection_priority\": [],\n \"registered\": false,\n \"user_id\": null,\n \"user_uuid\": null,\n \"template_id\": null,\n \"connection_status\": null,\n \"lat\": \"37.3486\",\n \"lng\": \"-121.951\",\n \"locality\": \"95050\",\n \"homekit\": null,\n \"oem_id\": null,\n \"dealer\": null,\n \"facility_uuid\": null,\n \"imei\": null\n }\n }\n ]\n}"
? ''
: summary: ''
value: ''
Example response when pagination = False:
summary: Example response when pagination = False
value:
devices:
- device:
product_name: product_name
model: AY001MSL1
dsn: TESTDSN_6705023_000
oem_model: ledevb-test
sw_version: '1.0'
template_id: 625159
mac: 8a:8b:2b:15:6a:b4
unique_hardware_id: a8:02:c4:22:0c:31
hwsig: fypfhheq823zbxavwqt911
lan_ip: null
connected_at: '2026-06-08T17:20:01Z'
key: 7559190
lan_enabled: false
connection_priority: []
has_properties: true
product_class: product_class
connection_status: Offline
lat: '39.0469'
lng: '-77.4903'
locality: '20149'
device_type: Wifi
dealer: null
facility_uuid: null
manuf_model: test_mfg_model
oem: 0dfc7900
transport_type: mqtt-native
- device:
product_name: null
dsn: AC000W000000007
sw_version: bc 0.7 10/05/11 17:58:18 ID jre/canary/52689fa+
ip: 24.23.180.127
connected_at: '2011-10-07T18:18:11Z'
user_id: null
user_uuid: null
lat: '37.3486'
lng: '-121.951'
locality: '95050'
homekit: null
dealer: null
facility_uuid: null
'401':
content: {}
description: Unauthorized
tags:
- Devices.json
components:
securitySchemes:
sec0:
type: apiKey
in: header
name: Authorization
x-bearer-format: ''
x-default: auth_token
x-readme-fauxas: true
x-provenance:
method: searched
source: https://docs.aylanetworks.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.aylanetworks.com/reference/add-device-to-group.md
- https://docs.aylanetworks.com/reference/assign-dealer-to-group.md
- https://docs.aylanetworks.com/reference/associate-a-role-label.md
- https://docs.aylanetworks.com/reference/clear-schedule.md
- https://docs.aylanetworks.com/reference/create-a-datapoint-by-device-id.md
- https://docs.aylanetworks.com/reference/create-a-notification.md
- https://docs.aylanetworks.com/reference/create-a-schedule.md
- https://docs.aylanetworks.com/reference/create-associated-user-1.md
- https://docs.aylanetworks.com/reference/create-datapoint-by-dsn.md
- https://docs.aylanetworks.com/reference/create-datapoint-message-by-dsn.md
- https://docs.aylanetworks.com/reference/create-datapoints-in-group-1.md
- https://docs.aylanetworks.com/reference/create-datapoints-in-group.md
- https://docs.aylanetworks.com/reference/create-datapoints.md
- https://docs.aylanetworks.com/reference/create-device-metadata.md
- https://docs.aylanetworks.com/reference/create-group.md
- https://docs.aylanetworks.com/reference/create-notification-app.md
- https://docs.aylanetworks.com/reference/create-notification-app1.md
- https://docs.aylanetworks.com/reference/create-schedule-action.md
- https://docs.aylanetworks.com/reference/create-template-1.md
- https://docs.aylanetworks.com/reference/create-template-2.md
- https://docs.aylanetworks.com/reference/create-template-properties.md
- https://docs.aylanetworks.com/reference/create-template.md
- https://docs.aylanetworks.com/reference/create-trigger-1.md
- https://docs.aylanetworks.com/reference/create-trigger.md
- https://docs.aylanetworks.com/reference/delete-device-address.md
- https://docs.aylanetworks.com/reference/delete-device-metadata.md
- https://docs.aylanetworks.com/reference/delete-group.md
- https://docs.aylanetworks.com/reference/delete-notification-by-id.md
- https://docs.aylanetworks.com/reference/delete-notification.md
- https://docs.aylanetworks.com/reference/delete-role-label-by-id.md
- https://docs.aylanetworks.com/reference/delete-schedule-action-by-id.md
- https://docs.aylanetworks.com/reference/delete-trigger-apps-by-id.md
- https://docs.aylanetworks.com/reference/delete-trigger-by-id.md
- https://docs.aylanetworks.com/reference/disassociate-a-role-label-to-a-device.md
- https://docs.aylanetworks.com/reference/enable-role-on-device.md
- https://docs.aylanetworks.com/reference/factory-reset-device-id114.md
- https://docs.aylanetworks.com/reference/get-a-property-by-name.md
- https://docs.aylanetworks.com/reference/get-a-schedule-by-name.md
- https://docs.aylanetworks.com/reference/get-all-notifications.md
- https://docs.aylanetworks.com/reference/get-all-triggers.md
- https://docs.aylanetworks.com/reference/get-associated-devices-1.md
- https://docs.aylanetworks.com/reference/get-associated-devices-by-email.md
- https://docs.aylanetworks.com/reference/get-associated-devices.md
- https://docs.aylanetworks.com/reference/get-commands-1.md
- https://docs.aylanetworks.com/reference/get-commands.md
- https://docs.aylanetworks.com/reference/get-connection-history.md
- https://docs.aylanetworks.com/reference/get-datapoint-by-device-id.md
- https://docs.aylanetworks.com/reference/get-datapoint-by-dsn-id.md
- https://docs.aylanetworks.com/reference/get-datapoints-by-dsn.md
- https://docs.aylanetworks.com/reference/get-datapoints-in-group.md
- https://docs.aylanetworks.com/reference/get-device-address.md
- https://docs.aylanetworks.com/reference/get-device-by-device-id.md
- https://docs.aylanetworks.com/reference/get-device-by-dsn-1.md
- https://docs.aylanetworks.com/reference/get-device-by-dsn.md
- https://docs.aylanetworks.com/reference/get-device-metadata-by-key.md
- https://docs.aylanetworks.com/reference/get-device-metadata.md
- https://docs.aylanetworks.com/reference/get-device-role-label.md
- https://docs.aylanetworks.com/reference/get-group-by-id.md
- https://docs.aylanetworks.com/reference/get-groups.md
- https://docs.aylanetworks.com/reference/get-lan-data.md
- https://docs.aylanetworks.com/reference/get-nodes-by-device-id-id117.md
- https://docs.aylanetworks.com/reference/get-nodes-by-dsn-1.md
- https://docs.aylanetworks.com/reference/get-nodes-by-dsn.md
- https://docs.aylanetworks.com/reference/get-notification-app.md
- https://docs.aylanetworks.com/reference/get-notification-by-id-1.md
- https://docs.aylanetworks.com/reference/get-notification.md
- https://docs.aylanetworks.com/reference/get-notifications.md
- https://docs.aylanetworks.com/reference/get-properties-by-device-id.md
- https://docs.aylanetworks.com/reference/get-properties-by-dsn.md
- https://docs.aylanetworks.com/reference/get-registrable-device.md
- https://docs.aylanetworks.com/reference/get-role-label.md
- https://docs.aylanetworks.com/reference/get-schedule-action-by-id.md
- https://docs.aylanetworks.com/reference/get-schedule-action-by-name.md
- https://docs.aylanetworks.com/reference/get-schedule-action.md
- https://docs.aylanetworks.com/reference/get-schedule-by-id.md
- https://docs.aylanetworks.com/reference/get-schedules-for-user.md
- https://docs.aylanetworks.com/reference/get-schedules.md
- https://docs.aylanetworks.com/reference/get-template.md
- https://docs.aylanetworks.com/reference/get-timezone-1.md
- https://docs.aylanetworks.com/reference/get-timezone.md
- https://docs.aylanetworks.com/reference/get-trigger-app.md
- https://docs.aylanetworks.com/reference/get-trigger-apps.md
- https://docs.aylanetworks.com/reference/get-trigger-by-id.md
- https://docs.aylanetworks.com/reference/get-trigger.md
- https://docs.aylanetworks.com/reference/gets-datapoint-by-device-id.md
- https://docs.aylanetworks.com/reference/gets-property-by-device-di.md
- https://docs.aylanetworks.com/reference/identify-zigbee-node-id115.md
- https://docs.aylanetworks.com/reference/register-device-to-user.md
- https://docs.aylanetworks.com/reference/register-device.md
- https://docs.aylanetworks.com/reference/remove-device-from-group.md
- https://docs.aylanetworks.com/reference/rename-device-by-device-id.md
- https://docs.aylanetworks.com/reference/rename-group.md
- https://docs.aylanetworks.com/reference/search-devices.md
- https://docs.aylanetworks.com/reference/set-device-timezone.md
- https://docs.aylanetworks.com/reference/transfer-registration.md
- https://docs.aylanetworks.com/reference/unregister-a-device.md
- https://docs.aylanetworks.com/reference/unregister-device.md
- https://docs.aylanetworks.com/reference/update-device-address.md
- https://docs.aylanetworks.com/reference/update-device-location-id116.md
- https://docs.aylanetworks.com/reference/update-device-metadata.md
- https://docs.aylanetworks.com/reference/update-notification.md
- https://docs.aylanetworks.com/reference/update-role-label.md
- https://docs.aylanetworks.com/reference/update-schedule-action.md
- https://docs.aylanetworks.com/reference/update-schedule1.md
- https://docs.aylanetworks.com/reference/update-trigger-app.md
- https://docs.aylanetworks.com/reference/update-trigger1.md
merge:
pages: 106
deduped: 105
conflicts_kept_first: 0