attributes: name, created, id, lastReported, owner, platform, state.
For ascending, use only the attribute name. For descending order, prepend the attribute name with "-".
For example: sort: "-name"
| ## Get Devices By An Attribute In this example we will be fetching all devices with "tim" in the name using graphQL. This will return all devices with "tim" in the name and is not case sensitive. You can use any number of combinations of available attributes to narrow your result set further. Other available parameters available: | Parameter | Data Type | Description | | ----------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | application | Int |ID of the application type (service type). Using this parameter will return devices which have services of a given type and if the services are returned in the query will only include the services of this type. For example, if you request an application type id which is mapped to SSH and include the services, only services of type of SSH will be returned in the services array even when there are other services defined on the device.
To get available service types, please see Application Types
| | hardwareid | String | The hardware ID associated with the device. | | name | String | String which is present in the name of the device and is not case sensitive. | | platform | \[Int] | Array of platform IDs | | state | String | accepted values "active" and "inactive" | **Additional attributes will become available over time**. Please refer to the schema documentation for the extensive list. {% hint style="info" %} This example only shows some of the variables and available attributes for the device and service collections. {% endhint %} ```graphql #Query query getDevices($size: Int, $from: Int, $sort: String, $state: String, $name: String) { login { devices(size: $size, from: $from, sort: $sort, state: $state, name: $name) { total hasMore items { id name hardwareId created services { id name } } } } } #Variables { "size": 1000, "from": 0, "sort": "name", "state": "inactive", "name": "tim" } ``` Once you get the results, if the hasMore response returns true you know to do another fetch and in this case the from will increment to 1001 to fetch the next set, you could also determine this by iteration until you get to the total. Size is limited to 1000 max in each return. Response Example ```bash { "data": { "login": { "devices": { "total": 1200, "hasMore": true, "items": [ { "id": "8X:XX:XX:00:29:01:8e:ed", "name": "Bento Time Machine", "hardwareId": "dc:a6:32:19:8b:a3-xWoYf46uJ6QdtPXTloLb", "created": "2019-12-20T22:13:46.000Z", "services": [ { "id": "8X:XX:XX:00:29:01:8e:ed", "name": "ssh service" } ] }, ... ] } } } } ``` ## Update a Device/Service Name Only the owner of the device **or an admin on the organization owning the device** can update the name of the device or service. | Parameters | Data Type | Description | | ---------- | --------- | -------------------------------------------------------- | | serviceId | String | This is the device Id or service Id that will be updated | | name | String | The new name of the device or service | ```graphql mutation { renameService( serviceId: "80:00:00:01:23:45:67:89", name: "New Name" ) } ``` Query Response ```graphql { "data": { "renameService": true } } ``` ## Update a Device or Service Only the owner of the device **or an admin on the organization owning the device** can update a device. | Parameter | Data Type | Description | | ----------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | serviceId | String! | Required - The device Id or service Id that will be updated | | refresh | Boolean! | Boolean to send the updates to the device. This should be true to push the updated configuration to the device. | | enabled | Boolean | Configuration for the remoteit daemon on a service. It must be true to enable connections and online/offline state. Can be set to false if you would like to disable the service to reduce network ping traffic. | | application | Int |ID of the application type (service type). Using this parameter will return devices which have services of a given type and if the services are returned in the query will only include the services of this type. For example, if you request an application type id which is mapped to SSH and include the services, only services of type of SSH will be returned in the services array even when there are other services defined on the device.
To get available service types, please see Application Types
| | name | String | The name of the device or service | | host | String |Default is 127.0.0.1 (localhost) if the service runs locally on the device, if null it is treated like localhost.
OR
The local network IP address or fully qualified domain name to configure this as a jump service to a system on your local network.
| | port | String | The port for this service on the device. (Leave null for the Device) For example, SSH is 22 unless configured differently on your device | ```graphql mutation { updateDevice( deviceId: "80:00:00:98:01:23:45:67", refresh: true, name: "New Name", port: 22 ) } ``` Query Response ```graphql { "data": { "updateDevice": true } } ``` ## Delete Device Only the owner of the device **or an admin on the organization owning the device** can delete a device. Devices can only be deleted when the state is `inactive`. ```graphql mutation { deleteDevice( deviceId: "80:00:00:98:01:23:45:67" ) } ``` Query Response ```graphql { "data": { "deleteDevice": true } } ``` ## Remove a Service Only the owner of the device **or an admin on the organization owning the device** can remove a service from a device. {% hint style="danger" %} Services will be removed even if active and in use {% endhint %} ```graphql mutation { removeService( id:"80:00:00:98:01:23:45:67" ) } ``` Query Response ```graphql { "data": { "removeService": true } } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.remote.it/developer-tools/api/usage/devices-and-services.md?ask=