List remediations aggregated across campaigns for a target

Platform API 3.0

List remediations aggregated across campaigns for a target

Request

Returns a paginated collection of remediation categories for the selected campaigns (each category nests probes with summary, distinct issues, AI-layer fix including optional how-to steps, engineering guidance, and retest criteria). Fixes are per probe; there is no cross-probe combined recipe. Uses the same cursor / limit pagination as other list APIs (default limit 50, max 200); totalItems is the number of categories.

Campaign selection uses the latest finished campaign of each campaign group. By default the newest 20 of that selection are used (lastNCampaigns defaults to 20; allowed range 1–20). campaigns replaces the selection with an explicit list (at most 20 ids; cannot be combined with lastNCampaigns). After selection, campaign ids are unique-sorted and capped at 20. Optional severity, category, and sort filter and sort the results. Campaigns still remediating are omitted. Download the full report via GET .../remediations/report with the same campaign/filter query params.

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

campaignsArray of strings, (uuid), [ 1 .. 20 ] items

Comma-separated campaign ids to aggregate remediations for (at most 20 UUIDs). Sent once as a single value; each id must be a UUID, with no empty items, whitespace or duplicates (case-insensitive). Any id that does not belong to the target returns 404. Cannot be combined with lastNCampaigns.

lastNCampaignsinteger, [ 1 .. 20 ]

Use only the N newest campaigns of the latest-finished-per-group selection (1–20). Defaults to 20 when omitted. Cannot be combined with campaigns. Must be sent once.

Default:20

Optional. Comma-separated severities: critical, high, medium, low. Sent once as a single value. Any other value returns 400 REMEDIATIONS.SEVERITY_INVALID.

categorystring

Optional. Comma-separated category names. Sent once as a single value. At most 20 names of at most 100 characters each; otherwise 400 REMEDIATIONS.CATEGORY_INVALID.

sortstring

Optional. asr sorts by attack success rate, highest first. Omit for the default order (worst severity first, then name). Sent once. Any other value returns 400 REMEDIATIONS.SORT_INVALID.

Value:"asr"

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}/remediations?pretty=false&cursor=0&limit=50&campaigns=497f6eca-6276-4993-bfeb-53cbbbba6f08&lastNCampaigns=20&severity=string&category=string&sort=asr' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Collection of remediation categories (each with nested probes) for the same campaign ids and filters. Probe description is the campaign description; engineering guidance uses authorization; distinct issues use issue and evidence finding links. additionalData carries totalItems, cursor, and next like other list APIs.

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(RemediationCategory)required

Page of remediation categories (each nests probes). AI-layer and engineering fixes are on each probe (including optional aiLayerFix.howToImplement); there is no cross-probe combined recipe.

Response

{
  "supportToken": "5bac741e-3f1c-4cd4-ad0d-a1492df0a5cc",
  "additionalData": {
    "totalItems": "string",
    "cursor": 0,
    "next": "string"
  },
  "response": [
    { … }
  ]
}