Skip to content
Platform API 3.0
/
/
List scan campaigns for a...

List scan campaigns for a target

Request

Returns a paginated list of scan campaigns for the target, newest first. Use lastN to limit the list to the N newest campaigns.

Security
bearer-key
Path
orgUuidstring, (uuid)required
applicationUuidstring, (uuid)required
projectUuidstring, (uuid)required
targetIdstring, (uuid)required
Query
prettyboolean

When true, indent the JSON body (2 spaces) and render multiline string fields (e.g. YAML config) with literal newlines for human readability. Default off (compact JSON). Intended for interactive use; omit for clients that parse the body as strict JSON.

Default:false
cursorinteger, >= 0
Default:0
limitinteger, [ 1 .. 200 ]
Default:50
lastNinteger, [ 1 .. 200 ]

Return only the N newest campaigns. totalItems is capped at N and cursor / limit page within those N campaigns. Must be sent once.

Headers
X-Correlation-IDstring, (uuid)

Optional caller-supplied correlation id. Must be a UUID when present. When omitted or blank, the API generates a UUID. A non-UUID value returns 400 CORRELATION.INVALID. If a write fails because a UUID is already in use, the API returns 409 UUID.DUPLICATE. The value used (caller or generated) is echoed as supportToken and in the X-Correlation-ID response header.

curl -i -X GET \
  'https://baseUrl/api/v3.0/redteaming/orgs/{orgUuid}/applications/{applicationUuid}/projects/{projectUuid}/targets/{targetId}/campaigns?pretty=false&cursor=0&limit=50&lastN=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Campaign collection

Headers
X-Correlation-IDstring, (uuid)

Correlation id used for this request (caller-supplied UUID, or a UUID generated when the request omitted the header). Same value as supportToken.

Bodyapplication/json
supportTokenstring, (uuid)(SupportToken)required

Correlation id used for this request. Same value as the X-Correlation-ID response header.

additionalDataobject(AdditionalData)required
responseArray of objects(Campaign)required
Response
{
  "supportToken": "5bac741e-3f1c-4cd4-ad0d-a1492df0a5cc",
  "additionalData": {
    "totalItems": "string",
    "cursor": 0,
    "next": "string"
  },
  "response": [
    { … }
  ]
}