Skip to main content

Perform Config Search by Search Id

POST 

/search/api/v1/config/:id

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

Request

Path Parameters

    id stringrequired

    Search ID

Body

required

Config rule search by search id request parameters model

    limit int32

    Results per page

    withResourceJson boolean

    true = include resource JSON. Default is false.

    timeRange object

    Model for TimeRangeConfig

    value object

    Model for RelativeTimeDuration

    unit string

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

    Time unit

    amount int32

    Number of time units

    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

  • ]
  • nextPageToken string

    Page Token

Responses

success

Schema
    totalRows int64

    The total number of matching resources

    items object[]

    List of matching resources

  • Array [
  • rrn object

    Model for RRN

    cloudType string

    Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, OTHER, IBM]

    Cloud type

    resourceType string

    Resource type

    regionId string

    Region ID

    accountId string

    Account ID

    idmapId string

    Hashed generated ID

    resourceId string

    Resource ID

    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

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