Skip to main content

Perform Config Search V2

POST 
/search/api/v2/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.
  • The request specification now includes the startTime value, indicating the start time for the search. Additionally, the end time is implicitly set to the current system time.
  • The response has been updated to the transition of the value associated with 'resourceType' to newer and more descriptive name. (Ex: Instance to "EC2 Instance" for config query to list all EC2 instances). Additionally, A new field 'resourceTypeId' is introduced, which serves as a unique identifier for the resourceType.
  • The maximum number of results is 100 items. 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​

Body

required

Config rule search by query request parameters model

    limit int32

    Results per page

    withResourceJson boolean

    true = include resource JSON. Default is false.

    startTime int64

    startTime

    skipResult boolean

    Skip Search Result

    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

    Used as the request parameter pageToken in the Get The Next Search Page endpoint to retrieve the next page of search results

Responses​

success

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

    dynamicData object

    Dynamic data

    property name* 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

    resourceTypeId int64

    resourceTypeId

  • ]
    • 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

Loading...