Perform Config Search by Query

POST 
/search/api/v1/config

Returns the results of an RQL config query. With config queries, you can retrieve resource information, identify misconfigurations, gain operational insights, and uncover policy and compliance violations.

When a query returns over 100 results, the response includes the nextPageToken field which can be used as the request parameter pageToken in the Get The Next Search Page endpoint to retrieve the next page of search results.

Request

application/json; charset=UTF-8

Body

required

Config rule search by query request parameters model

skipSearchCreation boolean

Skip Search Creation. Default is false

limit int32

Results per page

withResourceJson boolean

true = include resource JSON. Default is false.

timeRange object

Model for TimeRangeConfig

type string

Possible values: [relative]

Time type

value object

Model for RelativeTimeDuration

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

amount int32

Number of time units

skipResult boolean

Skip Search Result. Default is false

sort object[]
Sort field data
Array [
field string
Possible values: [ID, TIME, API_NAME, CUSTOMER_ID, INSERT_TS, JSON, CLOUD_ACCOUNT, CLOUD_REGION, STATE_ID]
direction string
Possible values: [asc, desc]
Direction
]
query stringrequired

RQL query

nextPageToken string

Page Token

Responses

200

success

application/json; charset=UTF-8

Schema

Schema

totalRows int64

The total number of matching resources

items object[]
List of matching resources
Array [
rrn string
RRN
stateId string
State ID
assetId string
Asset ID
id string
ID
name string
Name
url string
URL
accountId string
Account ID
accountName string
Account name
accountGroupName string
Account group name
cloudType string
Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, OTHER, IBM]
Cloud Type
regionId string
Region ID
regionName string
Region name
service string
Service
resourceType string
Resource type
insertTs int64
Insertion timestamp
createdTs int64
Creation timestamp
deleted boolean
Deleted
vpcId string
Virtual private cloud ID
vpcName string
Virtual private cloud name
tags object
Tags
property name* string
riskGrade string
Risk grade
data object
Raw JSON data for the resource
object
dynamicData object
Dynamic data
property name* object
object
hasNetwork boolean
Has network
hasExternalFinding boolean
Has external finding
hasExternalIntegration boolean
Has external integration
allowDrillDown boolean
allowDrillDown
hasExtFindingRiskFactors boolean
Has risk factors
resourceConfigJsonAvailable boolean
allowDrillDown
]
dynamicColumns string[]

Set of names of custom resource attributes

nextPageToken string

Encoded page token to continue pagination

infoMsg string
sortAllowedColumns string[]
id string

Search id

Example (from schema)

{
  "totalRows": 0,
  "items": [
    {
      "rrn": "string",
      "stateId": "string",
      "assetId": "string",
      "id": "string",
      "name": "string",
      "url": "string",
      "accountId": "string",
      "accountName": "string",
      "accountGroupName": "string",
      "cloudType": "ALL",
      "regionId": "string",
      "regionName": "string",
      "service": "string",
      "resourceType": "string",
      "insertTs": 0,
      "createdTs": 0,
      "deleted": true,
      "vpcId": "string",
      "vpcName": "string",
      "tags": {},
      "riskGrade": "string",
      "data": {},
      "dynamicData": {},
      "hasNetwork": true,
      "hasExternalFinding": true,
      "hasExternalIntegration": true,
      "allowDrillDown": true,
      "hasExtFindingRiskFactors": true,
      "resourceConfigJsonAvailable": true
    }
  ],
  "dynamicColumns": [
    "string"
  ],
  "nextPageToken": "string",
  "infoMsg": "string",
  "sortAllowedColumns": [
    "string"
  ],
  "id": "string"
}

400

conflict_saved_search

404

not_found

Loading...