Search Configuration Items

Perform a paginated search across configuration items with filtering and sorting options. Returns a list of configuration items that match the search criteria.

Special Access Rules

To query configuration items, you must have the following user permissions:

IT Service Configuration Item Type Manager
IT Service Configuration Item Owner
IT Service Configuration Item Type Reader

Request

JSON example

1query SearchCI {
2  searchCI(
3    searchObject: {
4      pageSize: 10
5      filters: [
6        {
7          field: ci_tags_key_value_id
8          operator: EQUALS
9          values: ["764952:859952"]
10        },
11        {
12          field: first_discovered_on
13          operator: GREATER_THAN
14          values: ["1700000000000"]
15        }
16      ]
17      sort: [
18        {
19          sortKey: SD_ApNa
20          sortOrder: ASC
21        }
22      ]
23      cursor_position: "W251bGwsIjE3NjE4MDQ1OTExMzYiLCIzMjc2ODAxIl0="
24    }
25  ) {
26    totalCount
27    pageSize
28    next_cursor
29    hasMoreRecords
30    data {
31      id
32      CustomAttributeField
33      SD_Co
34      SD_LoBaPo
35      SD_LoBaSt
36      SD_SeSt
37      SD_LaTeAr
38      SD_AuScGrN
39      SD_DeCa
40      ciTags {
41        totalElements
42        ciTags {
43          tagId
44          tagValueId
45        }
46      discoveryInformation {
47        firstDiscoverdBy
48        firstDiscoveredOn
49      }
50    }
51  }
52}

Properties

Name	Type	Description	Required or Optional	Available Version
`searchObject`	SearchObject	An object containing filter criteria, pagination parameters, and sort options for the search query.	Required	66.0

SearchObject Properties

Properties

Name	Type	Description	Required or Optional	Available Version
`cursor_position`	String	A Base64-encoded cursor string used for pagination. Use the next_cursor value from the previous response to fetch the next page of results.	Optional	66.0
`filters`	FilterCriteria	An array of filter criteria objects that define the conditions to apply when searching configuration items.	Optional	66.0
`pageSize`	Integer	The maximum number of configuration item records to return in each page of results. If not specified, the value defaults to 10 records per page. The maximum value is 20.	Optional	66.0
`sort`	SortCriteria	An array of sort criteria objects that specify how to order the search results.	Optional	66.0

FilterCriteria Properties

Use FilterCriteria to filter search results based on field values.

1{
2  "field": "id",
3  "operator": "EQUALS",
4  "values": [
5    "101020"
6  ]
7}

Name	Type	Description	Required or Optional	Available Version
`field`	`SearchableField` (enumeration of type string)	The field name to use for filtering the search results. For valid values, see Valid field Values.	Required	66.0
`operator`	`FilterOperator` (enumeration of type string)	The comparison operator to use for filtering. For valid values, see Valid operator Values.	Required	66.0
`values`	Array of String	An array of values to match against the specified field. For `EQUALS` provide exactly one value. For `IN` provide one or more values.	Required	66.0

Valid field Values

In addition to the fields listed in the table, you can search on any custom attribute marked as filterable in the UI.

Note

Value	Label
`id`	Unique ID
`ci_tags_key_value_id`	Tag Key+Value Pair, or Key-Only Tag. Valid operator values: `EQUALS`, `NOT_EQUALS`, `IN`, and `NOT_IN`.
`ci_tags_key_id`	Tag Key Only. Valid operator values: `EQUALS` and `NOT_EQUALS`.
`ci_type`	Configuration item yype
`ci_type_developer_name`	Configuration item type developer name
`created_at`	Created time
`created_by_source`	Source that created the configuration item. Valid operator values: `EQUALS`, `NOT_EQUALS`, `IN`, and `NOT_IN`.
`first_discovered_on`	First discovery date. Valid operator values: `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `IS_BETWEEN`, and `NOT_BETWEEN`.
`first_discovered_by`	First discoverer. Valid operator values: `EQUALS`, `NOT_EQUALS`, `IN`, and `NOT_IN`.
`last_discovered_by`	Last discoverer. Valid operator values: `EQUALS`, `NOT_EQUALS`, `IN`, and `NOT_IN`.
`last_discovered_on`	Last discovered date. Valid operator values: `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `IS_BETWEEN`, and `NOT_BETWEEN`.
`last_discovery_source_name`	Discovery source name. Valid operator values: `EQUALS`, `NOT_EQUALS`, `IN`, and `NOT_IN`.
`last_discovery_source_timestamp`	Discovery source timestamp. Valid operator values: `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `IS_BETWEEN`, and `NOT_BETWEEN`.
`updated_at`	Last modified time
`SD_ApNa`	Application name
`SD_AsId`	Asset ID
`SD_AsNa`	Asset name
`SD_AwLoBaN`	AWS load balancer name
`SD_CiLo`	Configuration Item Location
`SD_CiOw`	Configuration Item Owner
`SD_CiOwGr`	Configuration Item Owner Group
`SD_Co`	Company
`SD_DeId`	Device ID/Deployment ID
`SD_DeLo`	Device Location
`SD_DeMaNa`	Device Manufacturer Name
`SD_DeMoNa`	Device Model Name
`SD_DeNa`	Device Name
`SD_DeSeNu`	Device Serial Number
`SD_De`	Description
`SD_DnHoNa`	DNS Host Name
`SD_EsNa`	ESXi Name
`SD_GrNa`	Group Name
`SD_HaVe`	Hardware Vendor
`SD_HoNa`	Host Name
`SD_ImNu`	IMEI Number
`SD_InNa`	Instance Name
`SD_InOw`	Instance Owner
`SD_IpAd`	IP Address
`SD_LiPrNa`	License Product Name
`SD_Ma`	Manufacturer
`SD_MeMa`	Memory Manufacturer
`SD_MoNu`	Model Number
`SD_NeHo`	Network Host
`SD_NeInNa`	Network Interface Name
`SD_NoNa`	Node Name
`SD_OpSy`	Operating System
`SD_OsTy`	OS Type
`SD_OsVe`	OS Vendor
`SD_PrDnNa`	Private DNS Name
`SD_PrIpAd`	Private IP Address
`SD_PrNa`	Process Name/Processor Name
`SD_PuDnNa`	Public DNS Name
`SD_PuIpAd`	Public IP Address
`SD_Re`	Region
`SD_SeNu`	Serial Number
`SD_SeIpAd`	Server IP Address
`SD_SeNa`	Server Name
`SD_SoNa`	Software Name
`SD_WeNa`	Website Name
`SD_WeTi`	Website Title
`SD_St`	Status
`SD_OsCl`	OS Class
`SD_Usu`	UsedBy (User)
`SD_UsuGr`	UsedBy (User Group)
`SD_MaAd`	MAC Address

Valid operator Values

Value	Description
`CONTAINS`	Matches if the field contains the specified value. Use with exactly one value in the values array.
`ENDS_WITH`	Matches if the field value ends with the specified value. Use with exactly one value in the values array.
`EQUALS`	Matches a single exact value. Use with exactly one value in the values array.
`GREATER_THAN`	Matches if the field value is greater than the specified value. Use with exactly one value in the values array.
`GREATER_THAN_OR_EQUAL`	Matches if the field value is greater than or equal to the specified value. Use with exactly one value in the values array.
`IN`	Matches any value in a list. Use with multiple values in the values array.
`IS_BETWEEN`	Matches if the field value is between two specified values (inclusive). Use with exactly two values in the values array.
`IS_EMPTY`	Matches if the field is empty or null. The values array should be empty or omitted.
`LESS_THAN`	Matches if the field value is less than the specified value. Use with exactly one value in the values array.
`LESS_THAN_OR_EQUAL`	Matches if the field value is less than or equal to the specified value. Use with exactly one value in the values array.
`NOT_BETWEEN`	Matches if the field value is not between two specified values (inclusive). Use with exactly two values in the values array.
`NOT_CONTAINS`	Matches if the field does not contain the specified value. Use with exactly one value in the values array.
`NOT_EMPTY`	Matches if the field is not empty or null. The values array should be empty or omitted.
`NOT_EQUALS`	Does not match a single exact value. Use with exactly one value in the values array.
`NOT_IN`	Does not match any value in a list. Use with multiple values in the values array.
`STARTS_WITH`	Matches if the field value starts with the specified value. Use with exactly one value in the values array.

SortCriteria

Use SortCriteria to specify how search results should be ordered.

1{
2  "sortKey": "SD_ApNa",
3  "sortOrder": "ASC"
4}

Name	Type	Description	Required or Optional	Available Version
`sortKey`	`sortFields` (enumeration of type string)	The field name to use for sorting the search results. Valid values are the same as for the `field` parameter. See Valid field Values.	Required	66.0
`sortOrder`	`SortOrder` (enumeration of type string)	The sort direction for the results. Values are `ASC` (Ascending) or `DESC` (Descending).	Required	66.0

Response

JSON example

This example is a sample response from the searchCI query.

1{
2  "data": {
3    "searchCI": {
4      "totalCount": 50,
5      "hasMoreRecords": true,
6      "lastModifiedOn": "1764831587989",
7      "data": [
8        {
9          "id": 19026901,
10          "name": "Phoenix Server",
11          "discoveryInformation": {
12            "firstDiscoveredBy": "AWS",
13            "firstDiscoveredOn": 1710000000000
14          },
15          "ciTags": {
16            "totalCount": 2,
17            "ciTags": [
18              {
19                "keyId": 764952,
20                "valueId": 859952
21              },
22              {
23                "keyId": 764953,
24                "valueId": 859953
25              }
26            ]
27          }
28        },
29        {
30          "id": 19026902,
31          "name": "Atlas Server",
32          "ciTags": {
33            "totalCount": 1,
34            "ciTags": [
35              {
36                "keyId": 764952,
37                "valueId": 859952
38              }
39            ]
40          }
41        }
42      ]
43    }
44  }
45}

Properties

Name	Type	Description	Available Version
`totalCount`	Integer	The total number of configuration item records that match the search criteria across all pages, regardless of pagination.	66.0
`hasMoreRecords`	Boolean	Indicates whether additional pages of results are available. Returns true if there are more records beyond the current page, false if this is the last page.	66.0
`data`	[CI]	An array of configuration item objects returned for the current page of results. Each object contains the fields requested in the query for matching configuration items.	66.0
`lastModifiedOn`	String	The date and time the record was last updated.	68.0

When using the searchCI operation, you can request any available attribute to be included in the response. The attributes you can include:

Standard Attributes: Many attributes are available out-of-the-box.
Custom Attributes: You can create and include custom attributes using the sObject API.

Add any attribute using its Developer Name (for example, SD_AsNa—Asset Name) to specify exactly which information you want to receive for your Configuration Items (CIs).

Note