Search K
Appearance
Get campaigns.
GET
/backend/v1/campaigns
Retrieves a list of campaigns that match the given criteria,
with the option to adjust the limit for more results.
Authorizations
HTTPBearer
TypeHTTP (bearer)
Parameters
Query Parameters
cursor
Selects page for paginated results. Pass in the next or prev attribute in the response
ascending
Whether results should be sorted in ascending order.
Typeboolean
default
falselimit
Number of results to return.
Typeinteger
default
10maximum
100minimum
1vendored
If true, return vendored campaigns created by the system.
Typeboolean
default
falseattackTechnique
Filter by campaigns that include an attack of these types
before
Only return campaigns created before this timestamp.
after
Only return campaigns created after this timestamp.
lastRunBefore
Only return campaigns that last ran before this timestamp.
lastRunAfter
Only return campaigns that last ran after this timestamp.
sortBy
Sort results by the given parameter.
Typestring
Enum
namecreated_atlast_runnum_of_runsincludeUsers
Include users
Typeboolean
default
falseResponses
Successful Response
application/json
JSON
{
"campaigns": [
{
"attacks": [
],
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"lastRun": "string",
"lastRunAt": "string",
"name": "string",
"runCount": 0,
"vendored": false
}
],
"next": "string",
"prev": "string",
"users": {
"additionalProperties": {
}
}
}