openapi: 3.2.0 info: title: groups-scenes Collections API version: '1.0' servers: - url: https://gss-dev.aylanetworks.com/groupsceneservice/v1/ security: - sec0: [] tags: - name: Collections paths: /collections/shares.json: post: summary: Share group or scene description: 'Use this API to share a group or scene with your household member. Use the parameter "resource_id" to specify the group or scene that you want to share. This parameter takes UUID of the group/scene as its value. To share all collections (all the groups or/and scenes), specify "*all_collections*" as the value to the "resource_id" parameter. **NOTE**: When you share a group/scene, its child resources will also be shared with the selected household member.' operationId: share-group-or-scene requestBody: content: application/json: schema: type: object properties: share: type: object properties: user_email: type: string description: Household member email with whom primary user going to share Collections. resource_id: type: string description: ID of the collections. operation: type: string description: Operation which will be performed by the household on resource. start_date_at: type: string description: Start date of sharing end_date_at: type: string description: The end date of sharing. email_template_id: type: string description: Custom email template when sharing collections. If no / invalid template is supplied, then default template will be used to send the emails. required: - user_email - resource_id - operation examples: {} responses: '201': description: Created content: application/json: examples: Result: value: share: user_email: stalinkalimuthu13@gmail.com owner_profile: email: aylaadminautomation@aylanetworks.com firstname: Jennifer lastname: Griffin owner_id: b02ce872-42d8-11f1-8aa5-f6a43ee69b74 created_at: '2026-05-19T10:28:30Z' accepted: true user_profile: email: stalinkalimuthu13@gmail.com firstname: Stalin lastname: Kalimuthu accepted_at: null updated_at: '2026-05-19T10:28:30Z' user_id: 1375dc78-536d-11f1-9f29-16d0225b1566 start_date_at: '2026-09-20T11:42:50Z' grant_id: -1 resource_id: 698a22e2-cc0e-48ed-b2e2-f065164ba794 end_date_at: '2026-09-26T11:42:50Z' id: bf04f9e2-6290-4abc-adf4-65b2ee22c2a2 resource_name: collection operation: read schema: type: object properties: share: type: object properties: user_email: type: string example: stalinkalimuthu13@gmail.com owner_profile: type: object properties: email: type: string example: aylaadminautomation@aylanetworks.com firstname: type: string example: Jennifer lastname: type: string example: Griffin owner_id: type: string example: b02ce872-42d8-11f1-8aa5-f6a43ee69b74 created_at: type: string example: '2026-05-19T10:28:30Z' accepted: type: boolean example: true default: true user_profile: type: object properties: email: type: string example: stalinkalimuthu13@gmail.com firstname: type: string example: Stalin lastname: type: string example: Kalimuthu accepted_at: type: string updated_at: type: string example: '2026-05-19T10:28:30Z' user_id: type: string example: 1375dc78-536d-11f1-9f29-16d0225b1566 start_date_at: type: string example: '2026-09-20T11:42:50Z' grant_id: type: integer example: -1 default: 0 resource_id: type: string example: 698a22e2-cc0e-48ed-b2e2-f065164ba794 end_date_at: type: string example: '2026-09-26T11:42:50Z' id: type: string example: bf04f9e2-6290-4abc-adf4-65b2ee22c2a2 resource_name: type: string example: collection operation: type: string example: read '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Collections get: summary: Get owned shares description: This API is used to retrieve the list of shared collections owned by the current user. operationId: get-shared-collections-owned-by-user responses: '200': description: OK content: application/json: examples: Result: value: share: user_email: stalinkalimuthu13@gmail.com owner_profile: email: aylaadminautomation@aylanetworks.com firstname: Jennifer lastname: Griffin owner_id: b02ce872-42d8-11f1-8aa5-f6a43ee69b74 created_at: '2026-05-19T10:28:30Z' accepted: true user_profile: email: stalinkalimuthu13@gmail.com firstname: Stalin lastname: Kalimuthu accepted_at: null updated_at: '2026-05-19T10:28:30Z' user_id: 1375dc78-536d-11f1-9f29-16d0225b1566 start_date_at: '2026-09-20T11:42:50Z' grant_id: -1 resource_id: 698a22e2-cc0e-48ed-b2e2-f065164ba794 end_date_at: '2026-09-26T11:42:50Z' id: bf04f9e2-6290-4abc-adf4-65b2ee22c2a2 resource_name: collection operation: read schema: type: object properties: share: type: object properties: user_email: type: string example: stalinkalimuthu13@gmail.com owner_profile: type: object properties: email: type: string example: aylaadminautomation@aylanetworks.com firstname: type: string example: Jennifer lastname: type: string example: Griffin owner_id: type: string example: b02ce872-42d8-11f1-8aa5-f6a43ee69b74 created_at: type: string example: '2026-05-19T10:28:30Z' accepted: type: boolean example: true default: true user_profile: type: object properties: email: type: string example: stalinkalimuthu13@gmail.com firstname: type: string example: Stalin lastname: type: string example: Kalimuthu accepted_at: type: integer updated_at: type: string example: '2026-05-19T10:28:30Z' user_id: type: string example: 1375dc78-536d-11f1-9f29-16d0225b1566 start_date_at: type: string example: '2026-09-20T11:42:50Z' grant_id: type: integer example: -1 default: 0 resource_id: type: string example: 698a22e2-cc0e-48ed-b2e2-f065164ba794 end_date_at: type: string example: '2026-09-26T11:42:50Z' id: type: string example: bf04f9e2-6290-4abc-adf4-65b2ee22c2a2 resource_name: type: string example: collection operation: type: string example: read '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden deprecated: false tags: - Collections /collections/shares/received.json: get: summary: Get received shares description: This API is used to retrieve the list of shared collections received by the current user. operationId: get-received-shares-1 responses: '200': description: OK content: application/json: examples: Result: value: - share: user_email: member@aylanetworks.com owner_profile: email: tom_owner@aylanetworks.com firstname: Tom lastname: Daniel owner_id: 4231a19e-7120-11eb-874c-acde48001122 created_at: '2021-02-18T16:25:44Z' accepted: true user_profile: email: member@aylanetworks.com firstname: Jon lastname: Y accepted_at: null updated_at: '2021-02-18T16:42:11Z' user_id: 230a1f12-7120-11eb-874c-acde48001122 start_date_at: null grant_id: -1 resource_id: 9055a3b8-4a5e-43e4-989a-cae97015c501 end_date_at: '2022-03-17T18:00:00Z' id: 3f5befe1-04e5-415c-94d0-79f7d90352b8 resource_name: collection operation: read schema: type: array items: type: object properties: share: type: object properties: user_email: type: string example: member@aylanetworks.com owner_profile: type: object properties: email: type: string example: tom_owner@aylanetworks.com firstname: type: string example: Tom lastname: type: string example: Daniel owner_id: type: string example: 4231a19e-7120-11eb-874c-acde48001122 created_at: type: string example: '2021-02-18T16:25:44Z' accepted: type: boolean example: true default: true user_profile: type: object properties: email: type: string example: member@aylanetworks.com firstname: type: string example: Jon lastname: type: string example: Y accepted_at: type: string updated_at: type: string example: '2021-02-18T16:42:11Z' user_id: type: string example: 230a1f12-7120-11eb-874c-acde48001122 start_date_at: type: integer grant_id: type: integer example: -1 default: 0 resource_id: type: string example: 9055a3b8-4a5e-43e4-989a-cae97015c501 end_date_at: type: string example: '2022-03-17T18:00:00Z' id: type: string example: 3f5befe1-04e5-415c-94d0-79f7d90352b8 resource_name: type: string example: collection operation: type: string example: read '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden deprecated: false tags: - Collections /collections/shares/{share_uuid}.json: put: summary: Update share description: This API is used to update the share details. operationId: update-share-1 parameters: - name: share_uuid in: path description: UUID of the share. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: share: properties: ' operation': type: string description: Read or write. start_date_at: type: string description: 'Example date format: "2022-02-02T05:31:01Z"' end_date_at: type: string description: 'Example date format: "2022-02-02T05:31:01Z"' required: [] type: object sort_by: type: string description: Field name. Based on this field, the results are sorted. default: created_at email_template_id: type: string description: Unique template identifier. responses: '200': description: OK content: application/json: examples: Result: value: share: user_email: stalinkalimuthu13@gmail.com owner_profile: email: aylaadminautomation@aylanetworks.com firstname: Jennifer lastname: Griffin owner_id: b02ce872-42d8-11f1-8aa5-f6a43ee69b74 created_at: '2026-05-19T10:28:30Z' accepted: true user_profile: email: stalinkalimuthu13@gmail.com firstname: Stalin lastname: Kalimuthu accepted_at: null updated_at: '2026-05-26T11:33:50Z' user_id: 1375dc78-536d-11f1-9f29-16d0225b1566 start_date_at: '2026-09-19T11:42:50Z' grant_id: -1 resource_id: 698a22e2-cc0e-48ed-b2e2-f065164ba794 end_date_at: '2026-09-26T11:42:50Z' id: bf04f9e2-6290-4abc-adf4-65b2ee22c2a2 resource_name: collection operation: read schema: type: object properties: share: type: object properties: user_email: type: string example: stalinkalimuthu13@gmail.com owner_profile: type: object properties: email: type: string example: aylaadminautomation@aylanetworks.com firstname: type: string example: Jennifer lastname: type: string example: Griffin owner_id: type: string example: b02ce872-42d8-11f1-8aa5-f6a43ee69b74 created_at: type: string example: '2026-05-19T10:28:30Z' accepted: type: boolean example: true default: true user_profile: type: object properties: email: type: string example: stalinkalimuthu13@gmail.com firstname: type: string example: Stalin lastname: type: string example: Kalimuthu accepted_at: type: string updated_at: type: string example: '2026-05-26T11:33:50Z' user_id: type: string example: 1375dc78-536d-11f1-9f29-16d0225b1566 start_date_at: type: string example: '2026-09-19T11:42:50Z' grant_id: type: integer example: -1 default: 0 resource_id: type: string example: 698a22e2-cc0e-48ed-b2e2-f065164ba794 end_date_at: type: string example: '2026-09-26T11:42:50Z' id: type: string example: bf04f9e2-6290-4abc-adf4-65b2ee22c2a2 resource_name: type: string example: collection operation: type: string example: read '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Collections delete: summary: Stop sharing collection description: This API is used to stop sharing of the specified collection share with a household member. operationId: stop-sharing-collection parameters: - name: share_uuid in: path description: Unique identifier of the share. required: true schema: type: string responses: '204': content: {} description: No Content '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found tags: - Collections /collections/{collection_uuid}.json: get: summary: Retrieve collection description: This API is used to retrieve a specific collection belonging to the user. operationId: retrieve-collection-1 parameters: - name: collection_uuid in: path description: UUID of the collection (group or scene) you want to retrieve. schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: collection_uuid: 96fca825-9fb9-40c2-80f1-4df714983691 name: Scene schedule type: SCENE is_active: true devices: - dsn: TESTDSN_3702488_002 product_name: TESTDEVICE_002 oem_model: ledevb-test lan_enabled: false connected_at: '2026-05-06T14:40:16Z' connection_status: Online states: - property_name: integer_output_tp base_type: integer property_value: 1 child_collections: [] custom_attributes: {} schedule: end_date: '2026-12-27' days_of_week: - 1 - 2 - 3 - 4 - 5 - 6 - 7 months_of_year: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 start_time_each_day: '14:42:16' name: Trigger schedule test days_of_month: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 active: true start_date: '2026-05-06' metadata: {} schema: type: object properties: collection_uuid: type: string example: 96fca825-9fb9-40c2-80f1-4df714983691 name: type: string example: Scene schedule type: type: string example: SCENE is_active: type: boolean example: true default: true devices: type: array items: type: object properties: dsn: type: string example: TESTDSN_3702488_002 product_name: type: string example: TESTDEVICE_002 oem_model: type: string example: ledevb-test lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T14:40:16Z' connection_status: type: string example: Online states: type: array items: type: object properties: property_name: type: string example: integer_output_tp base_type: type: string example: integer property_value: type: integer example: 1 default: 0 child_collections: type: array items: type: object properties: {} custom_attributes: type: object properties: {} schedule: type: object properties: end_date: type: string example: '2026-12-27' days_of_week: type: array items: type: integer example: 1 default: 0 months_of_year: type: array items: type: integer example: 1 default: 0 start_time_each_day: type: string example: '14:42:16' name: type: string example: Trigger schedule test days_of_month: type: array items: type: integer example: 1 default: 0 active: type: boolean example: true default: true start_date: type: string example: '2026-05-06' metadata: type: object properties: {} '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden deprecated: false tags: - Collections put: summary: Update collection name description: This API is used to update the name of the existing collection. operationId: update-collection-name-1 parameters: - name: collection_uuid in: path description: UUID of the collection. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: name: type: string description: New name of the collection. responses: '200': description: OK content: application/json: examples: Result: value: collection_uuid: 96fca825-9fb9-40c2-80f1-4df714983691 name: Scene schedule type: SCENE is_active: true devices: - dsn: TESTDSN_3702488_002 product_name: TESTDEVICE_002 oem_model: ledevb-test lan_enabled: false connected_at: '2026-05-06T14:40:16Z' connection_status: Online states: - property_name: integer_output_tp base_type: integer property_value: 1 child_collections: [] custom_attributes: {} schedule: end_date: '2026-12-27' days_of_week: - 1 - 2 - 3 - 4 - 5 - 6 - 7 months_of_year: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 start_time_each_day: '14:42:16' name: Trigger schedule test days_of_month: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 active: true start_date: '2026-05-06' metadata: {} schema: type: object properties: collection_uuid: type: string example: 96fca825-9fb9-40c2-80f1-4df714983691 name: type: string example: Scene schedule type: type: string example: SCENE is_active: type: boolean example: true default: true devices: type: array items: type: object properties: dsn: type: string example: TESTDSN_3702488_002 product_name: type: string example: TESTDEVICE_002 oem_model: type: string example: ledevb-test lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T14:40:16Z' connection_status: type: string example: Online states: type: array items: type: object properties: property_name: type: string example: integer_output_tp base_type: type: string example: integer property_value: type: integer example: 1 default: 0 child_collections: type: array items: type: object properties: {} custom_attributes: type: object properties: {} schedule: type: object properties: end_date: type: string example: '2026-12-27' days_of_week: type: array items: type: integer example: 1 default: 0 months_of_year: type: array items: type: integer example: 1 default: 0 start_time_each_day: type: string example: '14:42:16' name: type: string example: Trigger schedule test days_of_month: type: array items: type: integer example: 1 default: 0 active: type: boolean example: true default: true start_date: type: string example: '2026-05-06' metadata: type: object properties: {} '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Collections /collections/{collection_uuid}/collection_metadata.json: put: summary: Update custom attributes description: This API is used to update custom attributes associated with the specified collection. operationId: update-custom-attributes parameters: - name: collection_uuid in: path description: UUID of the collection (group or scene). schema: type: string required: true requestBody: content: application/json: schema: type: object properties: custom_attributes: type: object properties: color: type: string sort_order: type: string required: - color - sort_order responses: '200': description: OK content: application/json: examples: Result: value: collection_uuid: 1bc6f3d4-ba22-45d9-b87c-9109f6407260 name: MC1WV6LV type: SCENE is_active: true devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline states: - property_name: integer_input_tp base_type: integer property_value: 1008 child_collections: - collection_uuid: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: 8XSGU90V states: - property_name: prop_name1 base_type: boolean property_value: 1 custom_attributes: color: '#F08089' sort_order: descending schedule: {} schema: type: object properties: collection_uuid: type: string example: 1bc6f3d4-ba22-45d9-b87c-9109f6407260 name: type: string example: MC1WV6LV type: type: string example: SCENE is_active: type: boolean example: true default: true devices: type: array items: type: object properties: dsn: type: string example: AC000W000458392 product_name: type: string example: Ayla Devkit oem_model: type: string example: AylaShield lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T07:57:37Z' connection_status: type: string example: Offline states: type: array items: type: object properties: property_name: type: string example: integer_input_tp base_type: type: string example: integer property_value: type: integer example: 1008 default: 0 child_collections: type: array items: type: object properties: collection_uuid: type: string example: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: type: string example: 8XSGU90V states: type: array items: type: object properties: property_name: type: string example: prop_name1 base_type: type: string example: boolean property_value: type: integer example: 1 default: 0 custom_attributes: type: object properties: color: type: string example: '#F08089' sort_order: type: string example: descending schedule: type: object properties: {} '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Collections post: summary: Add attributes to collection description: This API is used to add custom attributes to a collection. operationId: add-attributes-to-collection parameters: - name: collection_uuid in: path description: UUID of the collection to which you want to add custom attributes. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '201': description: Created content: application/json: examples: Result: value: collection_uuid: 1bc6f3d4-ba22-45d9-b87c-9109f6407260 name: MC1WV6LV type: SCENE is_active: true devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline states: - property_name: integer_input_tp base_type: integer property_value: 1008 child_collections: - collection_uuid: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: 8XSGU90V states: - property_name: prop_name1 base_type: boolean property_value: 1 custom_attributes: color: '#F08080' sort_order: ascending schedule: {} schema: type: object properties: collection_uuid: type: string example: 1bc6f3d4-ba22-45d9-b87c-9109f6407260 name: type: string example: MC1WV6LV type: type: string example: SCENE is_active: type: boolean example: true default: true devices: type: array items: type: object properties: dsn: type: string example: AC000W000458392 product_name: type: string example: Ayla Devkit oem_model: type: string example: AylaShield lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T07:57:37Z' connection_status: type: string example: Offline states: type: array items: type: object properties: property_name: type: string example: integer_input_tp base_type: type: string example: integer property_value: type: integer example: 1008 default: 0 child_collections: type: array items: type: object properties: collection_uuid: type: string example: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: type: string example: 8XSGU90V states: type: array items: type: object properties: property_name: type: string example: prop_name1 base_type: type: string example: boolean property_value: type: integer example: 1 default: 0 custom_attributes: type: object properties: color: type: string example: '#F08080' sort_order: type: string example: ascending schedule: type: object properties: {} '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Collections get: summary: Get custom attributes description: This API is used to retrieve custom attributes associated with the specified collection. operationId: retrieve-collection-2 parameters: - name: collection_uuid in: path description: UUID of the collection (group or scene). schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: custom_attributes: color: '#F08080' sort_order: ascending schema: type: object properties: custom_attributes: type: object properties: color: type: string example: '#F08080' sort_order: type: string example: ascending '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden deprecated: false tags: - Collections /collections/{collection_uuid}/datapoint.json: get: summary: Get last posted datapoints for a collection description: This API is used to retrieve last datapoints for collection associated with multiple devices (Group Only). operationId: get-last-posted-datapoints-for-a-collection responses: '200': description: '200' content: application/json: examples: Result: value: "[\n {\n \"dsn\": \"TESTDSN_xxxxx_000\",\n \"name\": \"string_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:27Z\",\n \"created_at\": \"2021-02-24T18:37:27Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": \"My Strings\"\n }\n },\n {\n \"dsn\": \"TESTDSN_1xxxxx_000\",\n \"name\": \"integer_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:28Z\",\n \"created_at\": \"2021-02-24T18:37:28Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": 108\n }\n },\n {\n \"dsn\": \"TESTDSN_2xxxxxx_000\",\n \"name\": \"string_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:28Z\",\n \"created_at\": \"2021-02-24T18:37:28Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": \"My Strings\"\n }\n },\n {\n \"dsn\": \"TESTDSN_2xxxxx_000\",\n \"name\": \"integer_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:28Z\",\n \"created_at\": \"2021-02-24T18:37:28Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": 108\n }\n }\n]" schema: type: array items: type: object properties: dsn: type: string example: TESTDSN_xxxxx_000 name: type: string example: string_input_tp status: type: integer example: 201 default: 0 datapoint: type: object properties: updated_at: type: string example: '2021-02-24T18:37:27Z' created_at: type: string example: '2021-02-24T18:37:27Z' echo: type: boolean example: false default: true metadata: type: object properties: {} value: type: string example: My Strings '401': description: '401' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '403': description: '403' content: application/json: examples: Result: value: '' parameters: - in: query name: collections_uuid schema: type: string description: UUID of the group. tags: - Collections /collections/{collection_uuid}/delete_collection_metadata.json: delete: summary: Remove custom attributes description: 'This API is used to remove custom attributes associated with the specified collection. Note: PS: The response for the successful execution includes the rest of the collection object with status code 200.' operationId: remove-custom-attributes parameters: - name: collection_uuid in: path description: UUID of the collection. required: true schema: type: string requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '200': description: '200' content: application/json: examples: Result: value: '' '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '404': description: '404' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: false tags: - Collections /collections/{collection_uuid}/delete_devices_collections.json: delete: summary: Remove specific devices or child collections description: 'This API is used to remove specific devices or child collections from the specified collection. Note: PS: The response for the successful execution includes the rest of the collection object with status code 200.' operationId: remove-specific-devices-or-child-collections parameters: - name: collection_uuid in: path description: UUID of the collection. required: true schema: type: string requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '200': description: '200' content: application/json: examples: Result: value: '' '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '404': description: '404' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: false tags: - Collections /collections/{collection_uuid}/devices_collections.json: put: summary: Update or set states description: This API is used to update or set the state/action of each device or group associated with a scene. operationId: update-collection-name parameters: - name: collection_uuid in: path description: UUID of the collection. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '200': description: '200' content: application/json: examples: Result: value: '' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: false tags: - Collections /collections/{collection_uuid}/remove_devices_from_hierarchy.json: delete: summary: Remove devices description: This API is used to remove device(s) from the specified collection and all its child collections (if present). operationId: remove-devices parameters: - name: collection_uuid in: path description: UUID of the collection. required: true schema: type: string requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '200': content: application/json: schema: type: object properties: {} examples: OK: summary: OK value: '{}' description: OK '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity tags: - Collections /collections/{collections_uuid}.json: delete: summary: Delete collection description: This API is used to delete the specified collection(group or scene). operationId: delete-collection parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true responses: '204': content: application/json: schema: type: object properties: {} examples: No Content: summary: No Content value: '' description: No Content '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found tags: - Collections /collections/{collections_uuid}/activate.json: post: summary: Activate scene manually (Tap-to-run) description: 'This API is used to activate the specified scene manually (Tap-to-run). **NOTE**: - If you get response code 206, it indicates that some of the properties in the request are associated with the devices in the group and datapoint is posted successfully for them. - Possible reasons for getting 422 response code 1. "collection_uuid" is not available. 2. Property is not available. 3. All the device properties in the collection are incorrect and hence no datapoint is posted.' operationId: activate-scene-manually-tap-to-run parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: '' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '404': description: '404' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: false tags: - Collections /collections/{collections_uuid}/automation.json: put: summary: Enable/Disable scene automation description: This API is used to enable or disable the scene automation. operationId: enable-disable-scene-automation parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true - name: is_active in: query schema: type: boolean responses: '200': description: OK content: application/json: examples: Result: value: collection_uuid: 1bc6f3d4-xxxxx-b87c-9109f6407260 name: MC1WV6LV count_down_trigger_time: 1780396186472 type: SCENE is_active: true devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline states: - property_name: integer_input_tp base_type: integer property_value: 1008 child_collections: - collection_uuid: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: 8XSGU90V states: - property_name: prop_name1 base_type: boolean property_value: 1 custom_attributes: color: '#F08089' sort_order: descending schedule: {} schema: type: object properties: collection_uuid: type: string example: 1bc6f3d4-ba22-45d9-b87c-9109f6407260 name: type: string example: MC1WV6LV count_down_trigger_time: type: integer example: 1780396186472 default: 0 type: type: string example: SCENE is_active: type: boolean example: true default: true devices: type: array items: type: object properties: dsn: type: string example: AC000W000458392 product_name: type: string example: Ayla Devkit oem_model: type: string example: AylaShield lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T07:57:37Z' connection_status: type: string example: Offline states: type: array items: type: object properties: property_name: type: string example: integer_input_tp base_type: type: string example: integer property_value: type: integer example: 1008 default: 0 child_collections: type: array items: type: object properties: collection_uuid: type: string example: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: type: string example: 8XSGU90V states: type: array items: type: object properties: property_name: type: string example: prop_name1 base_type: type: string example: boolean property_value: type: integer example: 1 default: 0 custom_attributes: type: object properties: color: type: string example: '#F08089' sort_order: type: string example: descending schedule: type: object properties: {} '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found tags: - Collections /collections/{collections_uuid}/countdown.json: put: summary: Activate scene based on countdown timer description: This API is used to activate the specified scene based on the countdown timer. operationId: activate-scene-based-on-countdown-timer parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: count_down_timer: type: integer description: Time in minutes after which the scene will be triggered automatically. format: int32 responses: '200': description: OK content: application/json: examples: Result: value: collection_uuid: 1bc6f3d4-xxxx-b87c-9109f6407260 name: MC1WV6LV count_down_trigger_time: 1780396186472 type: SCENE is_active: false devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline states: - property_name: integer_input_tp base_type: integer property_value: 1008 child_collections: - collection_uuid: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: 8XSGU90V states: - property_name: prop_name1 base_type: boolean property_value: 1 custom_attributes: color: '#F08089' sort_order: descending schedule: {} schema: type: object properties: collection_uuid: type: string example: 1bc6f3d4-xxxx-b87c-9109f6407260 name: type: string example: MC1WV6LV count_down_trigger_time: type: integer example: 1780396186472 default: 0 type: type: string example: SCENE is_active: type: boolean example: false default: true devices: type: array items: type: object properties: dsn: type: string example: AC000W000458392 product_name: type: string example: Ayla Devkit oem_model: type: string example: AylaShield lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T07:57:37Z' connection_status: type: string example: Offline states: type: array items: type: object properties: property_name: type: string example: integer_input_tp base_type: type: string example: integer property_value: type: integer example: 1008 default: 0 child_collections: type: array items: type: object properties: collection_uuid: type: string example: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: type: string example: 8XSGU90V states: type: array items: type: object properties: property_name: type: string example: prop_name1 base_type: type: string example: boolean property_value: type: integer example: 1 default: 0 custom_attributes: type: object properties: color: type: string example: '#F08089' sort_order: type: string example: descending schedule: type: object properties: {} '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found tags: - Collections /collections/{collections_uuid}/datapoint.json: post: summary: Post datapoints to collection description: 'This API is used to post datapoints to a group associated with multiple devices. **NOTE**: If you get response code 206, it indicates that some of the properties in the request are associated with the devices in the group and datapoint is posted successfully for them.' operationId: post-datapoints-to-collection parameters: - name: collections_uuid in: path description: UUID of the group. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '201': description: '201' content: application/json: examples: Result: value: "[\n {\n \"dsn\": \"TESTDSN_122297_000\",\n \"name\": \"string_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:27Z\",\n \"created_at\": \"2021-02-24T18:37:27Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": \"My Strings\"\n }\n },\n {\n \"dsn\": \"TESTDSN_122297_000\",\n \"name\": \"integer_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:28Z\",\n \"created_at\": \"2021-02-24T18:37:28Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": 108\n }\n },\n {\n \"dsn\": \"TESTDSN_223051_000\",\n \"name\": \"string_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:28Z\",\n \"created_at\": \"2021-02-24T18:37:28Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": \"My Strings\"\n }\n },\n {\n \"dsn\": \"TESTDSN_223051_000\",\n \"name\": \"integer_input_tp\",\n \"status\": 201,\n \"datapoint\": {\n \"updated_at\": \"2021-02-24T18:37:28Z\",\n \"created_at\": \"2021-02-24T18:37:28Z\",\n \"echo\": false,\n \"metadata\": {},\n \"value\": 108\n }\n }\n]" schema: type: array items: type: object properties: dsn: type: string example: TESTDSN_122297_000 name: type: string example: string_input_tp status: type: integer example: 201 default: 0 datapoint: type: object properties: updated_at: type: string example: '2021-02-24T18:37:27Z' created_at: type: string example: '2021-02-24T18:37:27Z' echo: type: boolean example: false default: true metadata: type: object properties: {} value: type: string example: My Strings '206': description: '206' content: text/plain: examples: Result: value: '' '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '422': content: {} description: Unprocessable Entity tags: - Collections /collections/{collections_uuid}/delete_schedule.json: delete: summary: Delete schedule description: This API is used to delete the schedule associated with the specified scene. operationId: delete-schedule parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true responses: '204': content: {} description: No Content '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found tags: - Collections /collections/{collections_uuid}/devices_collections.json: post: summary: Add devices or child collections description: 'Use this API to add devices or child collections to already exiting collection. A collection is a group of things. In smart home concept, a collection can represent a Household, Home, Room, or an Apartment.' operationId: add-devices-or-child-collections parameters: - name: collections_uuid in: path description: UUID of the group or scene to which you want to add devices or child collections. schema: type: string required: true - name: type in: query description: Type of the collection. It can be either "GROUP" or "SCENE". required: true schema: type: string requestBody: content: application/json: schema: type: object properties: RAW_BODY: type: string format: json responses: '201': description: Created content: application/json: examples: Group: value: collection_uuid: 0351ff65-6728-4e0b-a186-7598739f05cc name: CT90RV1T type: GROUP devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline - dsn: AC000W046761301 product_name: Ayla Devkit oem_model: ledevb lan_enabled: false connected_at: '2026-05-06T07:44:46Z' connection_status: Offline child_collections: - collection_uuid: 0387b969-a5ba-4e1f-a283-27c89cbfc55c name: 8EMH5IIB - collection_uuid: 414a2595-29af-49ed-b8c1-81cf80f4ba82 name: CT90RV1T custom_attributes: {} schedules: [] summary: Group Scene: summary: Scene value: collection_uuid: 1bc6f3d4-ba22-45d9-b87c-9109f6407260 name: MC1WV6LV type: SCENE is_active: true devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline states: - property_name: integer_input_tp base_type: integer property_value: 1008 child_collections: - collection_uuid: dbdc4cad-0b09-4245-8f1a-2910b7179f41 name: 8XSGU90V states: - property_name: prop_name1 base_type: boolean property_value: 1 custom_attributes: {} schedule: {} schema: type: object properties: collection_uuid: type: string example: 0351ff65-6728-4e0b-a186-7598739f05cc name: type: string example: CT90RV1T type: type: string example: GROUP devices: type: array items: type: object properties: dsn: type: string example: AC000W000458392 product_name: type: string example: Ayla Devkit oem_model: type: string example: AylaShield lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T07:57:37Z' connection_status: type: string example: Offline child_collections: type: array items: type: object properties: collection_uuid: type: string example: 0387b969-a5ba-4e1f-a283-27c89cbfc55c name: type: string example: 8EMH5IIB custom_attributes: type: object properties: {} schedules: type: array items: type: object properties: {} '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Collections /collections/{collections_uuid}/schedule.json: post: summary: Activate scene based on schedule (DEPRECATED) description: 'This API is used to activate the specified scene based on a schedule. **NOTE**: This API is deprecated. Please refer to schedule_2 endpoint.' operationId: activate-scene-based-on-schedule parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: schedule: properties: active: type: boolean start_date: type: string description: (YYYY-MM-DD) end_date: type: string description: (YYYY-MM-DD) end_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' name': type: string description: Schedule name. days_of_month: type: array description: An array of integer. Contains days between 1-31. items: type: integer format: int32 days_of_week: type: array description: An array of integer. Contains days between 1-7. items: type: integer format: int32 months_of_year: type: array description: Array of integer. Contains months between 1-12. items: type: integer format: int32 start_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' metadata': type: string format: json required: [] type: object time_zone: type: string description: Location time zone name. responses: '200': description: '200' content: application/json: examples: Result: value: '' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '404': description: '404' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: true tags: - Collections /collections/{collections_uuid}/schedule_2.json: post: summary: Activate scene based on schedule_2 description: This API is used to activate the specified scene based on a schedule. operationId: activate-scene-based-on-schedule_2 parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: schedule: properties: active: type: boolean start_date: type: string description: (YYYY-MM-DD) end_date: type: string description: (YYYY-MM-DD) end_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' name': type: string description: Schedule name. days_of_month: type: array description: An array of integer. Contains days between 1-31. items: type: integer format: int32 days_of_week: type: array description: An array of integer. Contains days between 1-7. items: type: integer format: int32 months_of_year: type: array description: Array of integer. Contains months between 1-12. items: type: integer format: int32 start_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' metadata': type: string format: json required: [] type: object time_zone: type: string description: Location time zone name. utc: type: boolean description: Indicates the schedule to be set with UTC time zone or local time zone. responses: '200': description: '200' content: application/json: examples: Result: value: '' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '404': description: '404' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: false tags: - Collections /collections/{collections_uuid}/update_schedule.json: put: summary: Update schedule (DEPRECATED) description: 'This API is used to update the existing schedule of the specified scene. **NOTE** : This API is deprecated. Please refer to update_schedule_2 endpoint.' operationId: update-schedule parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: schedule: properties: active: type: boolean start_date: type: string description: (YYYY-MM-DD) end_date: type: string description: (YYYY-MM-DD) end_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' name': type: string description: Schedule name. days_of_month: type: array description: An array of integer. Contains days between 1-31. items: type: integer format: int32 days_of_week: type: array description: An array of integer. Contains days between 1-7. items: type: integer format: int32 months_of_year: type: array description: Array of integer. Contains months between 1-12. items: type: integer format: int32 start_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' metadata': type: string format: json required: [] type: object responses: '200': description: '200' content: application/json: examples: Result: value: '' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '401': description: '401' content: text/plain: examples: Result: value: '' '403': description: '403' content: text/plain: examples: Result: value: '' '404': description: '404' content: text/plain: examples: Result: value: '' '422': description: '422' content: text/plain: examples: Result: value: '' deprecated: true tags: - Collections /collections/{collections_uuid}/update_schedule_2.json: put: summary: Update schedule_2 description: This API is used to update the existing schedule of the specified scene. operationId: update-schedule_2 parameters: - name: collections_uuid in: path description: UUID of the scene. schema: type: string required: true requestBody: content: application/json: schema: type: object properties: schedule: properties: active: type: boolean start_date: type: string description: (YYYY-MM-DD) end_date: type: string description: (YYYY-MM-DD) end_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' name': type: string description: Schedule name. days_of_month: type: array description: An array of integer. Contains days between 1-31. items: type: integer format: int32 days_of_week: type: array description: An array of integer. Contains days between 1-7. items: type: integer format: int32 months_of_year: type: array description: Array of integer. Contains months between 1-12. items: type: integer format: int32 start_time_each_day: type: string description: 24 hour format (hh:mm:ss). ' metadata': type: string format: json required: [] type: object time_zone: type: string description: Location time zone name. utc: type: boolean description: Indicates the schedule to be set with UTC time zone or local time zone. responses: '200': description: OK content: application/json: examples: Result: value: collection_uuid: 96fca825-xxxx-80f1-4df714983691 name: Scene schedule type: SCENE is_active: true devices: - dsn: TESTDSN_3702488_002 product_name: TESTDEVICE_002 oem_model: ledevb-test lan_enabled: false connected_at: '2026-05-06T14:40:16Z' connection_status: Online states: - property_name: integer_output_tp base_type: integer property_value: 1 child_collections: [] custom_attributes: {} schedule: end_date: '2026-12-27' days_of_week: - 1 - 2 - 3 - 4 - 5 - 6 - 7 months_of_year: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 start_time_each_day: '14:42:16' name: Trigger schedule test days_of_month: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 active: false ' name': testing start_date: '2026-05-06' metadata: {} schema: type: object properties: collection_uuid: type: string example: 96fca825-xxxx-80f1-4df714983691 name: type: string example: Scene schedule type: type: string example: SCENE is_active: type: boolean example: true default: true devices: type: array items: type: object properties: dsn: type: string example: TESTDSN_3702488_002 product_name: type: string example: TESTDEVICE_002 oem_model: type: string example: ledevb-test lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T14:40:16Z' connection_status: type: string example: Online states: type: array items: type: object properties: property_name: type: string example: integer_output_tp base_type: type: string example: integer property_value: type: integer example: 1 default: 0 child_collections: type: array items: type: object properties: {} custom_attributes: type: object properties: {} schedule: type: object properties: end_date: type: string example: '2026-12-27' days_of_week: type: array items: type: integer example: 1 default: 0 months_of_year: type: array items: type: integer example: 1 default: 0 start_time_each_day: type: string example: '14:42:16' name: type: string example: Trigger schedule test days_of_month: type: array items: type: integer example: 1 default: 0 active: type: boolean example: false default: true ' name': type: string example: testing start_date: type: string example: '2026-05-06' metadata: type: object properties: {} '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity tags: - Collections /collections/{dsn}.json: get: summary: Get collections by "dsn" and "type" description: This API is used to retrieve the list of collections by input "dsn" and collection "type". operationId: get-collections-by-dsn-and-type parameters: - name: type in: query description: Type of the collection. It can be either "GROUP" or "SCENE". The parameter value is case insensitive. required: true schema: type: string - name: paginated in: query description: Indicate if pagination is required or not. True or fale. schema: type: boolean - name: per_page in: query description: Indicates number of items to be displayed per page. schema: type: integer format: int32 - name: page in: query description: Page number to be displayed. schema: type: integer format: int32 - name: sort_by in: query description: Field name. Based on this field, the results are sorted. schema: type: string default: created_at - name: order_by in: query description: asc or desc schema: type: string - name: dsn in: path description: Unique device serial number. schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: collections: - collection_uuid: 0351ff65-6728-4e0b-a186-7598739f05cc name: CT90RV1T type: GROUP devices: - dsn: AC000W000458392 product_name: Ayla Devkit oem_model: AylaShield lan_enabled: false connected_at: '2026-05-06T07:57:37Z' connection_status: Offline - dsn: AC000W046761301 product_name: Ayla Devkit oem_model: ledevb lan_enabled: false connected_at: '2026-05-06T07:44:46Z' connection_status: Offline child_collections: - collection_uuid: 0387b969-a5ba-4e1f-a283-27c89cbfc55c name: 8EMH5IIB - collection_uuid: 414a2595-29af-49ed-b8c1-81cf80f4ba82 name: CT90RV1T custom_attributes: {} schedules: [] total: 1 previous_page: null next_page: null current_page_number: 1 start_count_on_page: 1 end_count_on_page: 1 schema: type: object properties: collections: type: array items: type: object properties: collection_uuid: type: string example: 0351ff65-6728-4e0b-a186-7598739f05cc name: type: string example: CT90RV1T type: type: string example: GROUP devices: type: array items: type: object properties: dsn: type: string example: AC000W000458392 product_name: type: string example: Ayla Devkit oem_model: type: string example: AylaShield lan_enabled: type: boolean example: false default: true connected_at: type: string example: '2026-05-06T07:57:37Z' connection_status: type: string example: Offline child_collections: type: array items: type: object properties: collection_uuid: type: string example: 0387b969-a5ba-4e1f-a283-27c89cbfc55c name: type: string example: 8EMH5IIB custom_attributes: type: object properties: {} schedules: type: array items: type: object properties: {} total: type: integer example: 1 default: 0 previous_page: type: integer next_page: type: integer 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: 1 default: 0 '400': content: {} description: Bad Request '401': content: {} description: Unauthorized '403': content: {} description: Forbidden deprecated: false tags: - Collections components: securitySchemes: sec0: type: apiKey in: header name: Authorization 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/activate-scene-based-on-countdown-timer.md - https://docs.aylanetworks.com/reference/activate-scene-based-on-schedule.md - https://docs.aylanetworks.com/reference/activate-scene-based-on-schedule_2.md - https://docs.aylanetworks.com/reference/activate-scene-manually-tap-to-run.md - https://docs.aylanetworks.com/reference/add-attributes-to-collection.md - https://docs.aylanetworks.com/reference/add-devices-or-child-collections.md - https://docs.aylanetworks.com/reference/create-group-1.md - https://docs.aylanetworks.com/reference/create-group-or-scene-deprecated.md - https://docs.aylanetworks.com/reference/delete-all-collections.md - https://docs.aylanetworks.com/reference/delete-collection.md - https://docs.aylanetworks.com/reference/delete-multiple-collections.md - https://docs.aylanetworks.com/reference/delete-schedule.md - https://docs.aylanetworks.com/reference/enable-disable-scene-automation.md - https://docs.aylanetworks.com/reference/get-collections-by-dsn-and-type.md - https://docs.aylanetworks.com/reference/get-last-posted-datapoints-for-a-collection.md - https://docs.aylanetworks.com/reference/get-received-shares-1.md - https://docs.aylanetworks.com/reference/get-shared-collections-owned-by-user.md - https://docs.aylanetworks.com/reference/post-datapoints-to-collection.md - https://docs.aylanetworks.com/reference/remove-custom-attributes.md - https://docs.aylanetworks.com/reference/remove-devices.md - https://docs.aylanetworks.com/reference/remove-specific-devices-or-child-collections.md - https://docs.aylanetworks.com/reference/retrieve-collection-1.md - https://docs.aylanetworks.com/reference/retrieve-collection-2.md - https://docs.aylanetworks.com/reference/retrieve-collections.md - https://docs.aylanetworks.com/reference/share-group-or-scene.md - https://docs.aylanetworks.com/reference/stop-sharing-collection.md - https://docs.aylanetworks.com/reference/update-collection-name-1.md - https://docs.aylanetworks.com/reference/update-collection-name.md - https://docs.aylanetworks.com/reference/update-custom-attributes.md - https://docs.aylanetworks.com/reference/update-schedule.md - https://docs.aylanetworks.com/reference/update-schedule_2.md - https://docs.aylanetworks.com/reference/update-share-1.md merge: pages: 32 deduped: 31 conflicts_kept_first: 0