> 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/search-compliance-plan-instances/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Search all compliance plan instances

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

Gets a list of all Compliance Plan Instances that match the search criteria.

Reference: https://docs.itential.com/itential-cloud/api-reference/configuration-manager/search-compliance-plan-instances

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `searchParams` (any or any or any, optional)

## Response

### 200

List of Compliance Plan Instances that match the search criteria

- `totalCount` (double, optional)
- `groups` (list of any, optional)

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "totalCount": 10,
  "groups": [
    {
      "plans": [
        {
          "batchId": "67ead32d5f12757d048a48df",
          "description": "",
          "finished": "2025-03-31T17:38:54.018Z",
          "id": "67ead32c5f12757d048a48de",
          "jobId": "93e9aafa34e24e81953dae00",
          "jobStatus": "complete",
          "name": "Cisco IOS",
          "nodes": [
            {
              "deviceGroups": [],
              "devices": [],
              "erroredDevices": [],
              "nodeId": "67e301050e358ba47dcf79bc",
              "processedDevices": [],
              "status": "completed",
              "treeId": "67e301050e358ba47dcf79bd",
              "variables": {},
              "version": "initial"
            }
          ],
          "planId": "67ead2e85f12757d048a48dd",
          "started": "2025-03-31T17:38:53.096Z",
          "startedBy": null,
          "throttle": 5,
          "updated": "2025-03-31T17:38:53.096Z",
          "updatedBy": null
        }
      ],
      "totalCount": 3
    }
  ]
}
```

**SDK Code**

```python
import requests

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

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/search/compliance_plan_instances';
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/search/compliance_plan_instances"

	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/search/compliance_plan_instances")

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/search/compliance_plan_instances")
  .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/search/compliance_plan_instances', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://example.itential.io/configuration_manager/search/compliance_plan_instances");
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/search/compliance_plan_instances")! 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()
```