Get Applications by RQL
POST/appid/search/api/v1/app
Get the list of applications and its details that matches the search query.
Note: You need
investigateApplicationRql
feature withRead
permission to access this endpoint. Verify if your permission group includes this feature using the Get Permission Group by ID endpoint. You can also check this in the Prisma Cloud console by ensuring thatInvestigate
>Applications
is enabled.
Request
Query Parameters
Unique identifier for the search query.
Possible values: [application
]
Type of search.
Whether the search query is saved.
Time range for the search query.
The actual query string for searching applications.
Responses
- 200
- 400
A JSON object containing the search results.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The unique identifier of the search result.
The name of the search result.
The description of the search result.
The type of search.
Indicates if the search is saved.
timeRange object
The type of time range.
The value for the time range.
The query string used for searching.
data object
The total number of rows in the result.
items object[]
The unique identifier of the application.
The name of the application.
The owner of the application.
The environment in which the application is running.
The business criticality of the application.
The type of application.
The total number of assets.
The number of impacted assets.
The count of vulnerabilities.
The count of alerts.
The count of findings.
Token for fetching the next page of results.
{
"id": "string",
"name": "string",
"description": "string",
"searchType": "string",
"saved": true,
"timeRange": {
"type": "string",
"value": "string"
},
"query": "string",
"data": {
"totalRows": 0,
"items": [
{
"applicationId": "string",
"name": "string",
"owner": "string",
"environment": "string",
"businessCriticality": "string",
"type": "string",
"totalAssets": 0,
"impactedAssets": 0,
"vulnCount": 0,
"alertCount": 0,
"findingCount": 0
}
],
"nextPageToken": "string"
}
}
Invalid search query.