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

# Find devices

POST http://localhost:3000/configuration_manager/devices
Content-Type: application/json

Gets a specific subset of devices for based on given options.

Reference: https://docs.itential.com/itential-platform/6/api-reference/configuration-manager/get-devices-filtered

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `options` (object, optional)
  - `limit` (integer, required)
  - `start` (integer, optional)
  - `filter` (object, optional)
    - `name` (string, optional)
    - `address` (string, optional)
    - `port` (string, optional)
  - `sort` (list of object, optional)
    - `name` (enum, optional)
      - Allowed values: `-1`, `1`
    - `address` (enum, optional)
      - Allowed values: `-1`, `1`
    - `port` (enum, optional)
      - Allowed values: `-1`, `1`
  - `order` (enum, optional)
    - Allowed values: `ascending`, `descending`
  - `adapterType` (list of string, optional)
  - `adapterId` (list of string, optional)
  - `exactMatch` (boolean, optional) — boolean that indicates if an exact result will be returned or not

## Response

### 200

Filtered/Sorted Devices

- `entity` (any, optional)
- `total` (integer, optional)
- `unique_device_count` (integer, optional)
- `return_count` (integer, optional)
- `start_index` (integer, optional)
- `list` (list of object, optional)
  - `name` (string, required)
  - `ipaddress` (string, required)
  - `port` (string, required)
  - `device-type` (string, required)
  - `ostype` (string, required)
  - `host` (string, required)
  - `actions` (list of string, required)
  - `authgroup` (string, optional)
  - `address` (string, optional)
  - `ned` (string, optional)
  - `admin` (boolean, optional)
  - `origins` (list of string, optional)

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "entity": null,
  "total": 1,
  "unique_device_count": 1,
  "return_count": 1,
  "start_index": 1,
  "list": [
    {
      "name": "xr9kv01-aws",
      "ipaddress": "10.1.6.100",
      "port": "22",
      "device-type": "cli",
      "ostype": "cisco-ios-xr",
      "host": "nso46",
      "actions": [
        "addDevice"
      ],
      "authgroup": "xr9kv-aws",
      "address": "10.1.6.100",
      "ned": "cisco-ios-xr",
      "admin": true,
      "origins": [
        "nso46"
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:3000/configuration_manager/devices"

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

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

print(response.json())
```

```javascript
const url = 'http://localhost:3000/configuration_manager/devices';
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 := "http://localhost:3000/configuration_manager/devices"

	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("http://localhost:3000/configuration_manager/devices")

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

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("http://localhost:3000/configuration_manager/devices")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:3000/configuration_manager/devices', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:3000/configuration_manager/devices");
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: "http://localhost:3000/configuration_manager/devices")! 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()
```