> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/itential-cloud/api-reference/configuration-manager/get-devices/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Search and filter devices

POST https://example.itential.io/configuration_manager/devices/search
Content-Type: application/json

Returns a paginated list of devices from the device status collection with support for free-text search, filtering by group, plan, OS types, connection status, compliance score, and backup state.

Reference: https://docs.itential.com/itential-cloud/api-reference/configuration-manager/get-devices

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Body (application/json)

This endpoint expects an object.

- `payload` (object, optional)
  - `search` (string, optional, default: ) — Free-text search across device name, IP address, OS type, group names, and plan names
  - `filters` (object, optional) — Filter criteria
    - `groupNames` (list of string, optional) — Filter by device group names
    - `planNames` (list of string, optional) — Filter by compliance plan names
    - `groupIds` (list of string, optional) — Filter by device group IDs
    - `planIds` (list of string, optional) — Filter by compliance plan IDs
    - `deviceOsTypes` (list of string, optional) — Filter by device OS types
    - `status` (list of string, optional) — Filter by connection status values
    - `complianceScore` (object, optional) — Numeric range filter for latest compliance score
      - `gt` (double, optional)
      - `gte` (double, optional)
      - `lt` (double, optional)
      - `lte` (double, optional)
      - `eq` (double, optional)
    - `hasBackup` (boolean, optional) — Filter devices that have or have not been backed up
    - `isStaleBackup` (boolean, optional) — Filter devices whose last backup is stale
    - `isAudited` (boolean, optional) — Filter devices that have or have not been compliance-audited
  - `sort` (object, optional) — Sort options
    - `field` (enum, optional, default: deviceName) — Field to sort by
      - Allowed values: `deviceName`, `ipAddress`, `deviceOsType`, `status`, `groupCount`, `planCount`, `lastComplianceScore`, `lastBackUpDuration`, `updatedAt`, `lastErrorAt`
    - `order` (enum, optional, default: asc)
      - Allowed values: `asc`, `desc`
  - `pagination` (object, optional) — Pagination options
    - `page` (integer, optional, default: 1) — Page number
    - `limit` (integer, optional, default: 25) — Number of results per page

## Response

### 200

Paginated list of devices with metadata

- `rows` (list of object, optional)
- `pagination` (object, optional)
  - `page` (integer, optional)
  - `limit` (integer, optional)
  - `totalRows` (integer, optional)
  - `totalPages` (integer, optional)

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "rows": [
    {}
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "totalRows": 1,
    "totalPages": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://example.itential.io/configuration_manager/devices/search"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://example.itential.io/configuration_manager/devices/search';
const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://example.itential.io/configuration_manager/devices/search"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://example.itential.io/configuration_manager/devices/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://example.itential.io/configuration_manager/devices/search")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://example.itential.io/configuration_manager/devices/search', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://example.itential.io/configuration_manager/devices/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://example.itential.io/configuration_manager/devices/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```