Search K
Appearance
Get scans.
GET
/backend/v1/scans
Retrieves a list of scan requests that match the given criteria,
with the option to adjust the limit for more results.
Authorizations
HTTPBearer
TypeHTTP (bearer)
Parameters
Query Parameters
cursor
Pass cursor from response to get next or prev page.
search
Only return results that match the given text.
limit
Limits the amount of results.
Typeinteger
default
10maximum
100minimum
1ascending
Whether results should be sorted in ascending order.
Typeboolean
default
falsebefore
Only return results from before this timestamp.
after
Only return results from after this timestamp.
externalMetadata
Only return results that match the given external metadata
(as a stringified json e.g. '{"key": "value"}' would return only prompts with a "key" entry matching "value")
onlyUser
Only returns prompts belonging to the authenticated user.
Typeboolean
default
trueoutcomes
Repeated query parameters of outcomes. Filters results by these outcomes.
default
endpointId
Only returns prompts sent to specified endpoints.
Typearray
default
projectId
Only returns prompts sent to specified projects.
Typearray
default
providerId
Only returns prompts sent to specified providers.
Typearray
default
Responses
Successful Response
application/json
JSON
{
"next": "string",
"prev": "string",
"scans": [
{
"externalMetadata": "string",
"extraInputs": "string",
"id": "string",
"input": "string",
"preserve": false,
"projectId": "string",
"receivedAt": "string",
"result": {
"outcome": "string",
"scannerResults": [
{
"completedDate": "string",
"customConfig": false,
"data": {
"matches": [
[
]
],
"type": "regex"
},
"outcome": "string",
"scanDirection": "string",
"scannerId": "string",
"scannerVersionMeta": "string",
"startedDate": "string"
}
]
},
"type": "scan",
"userId": "string"
}
]
}