Skip to content
Platform API 3.0
/
/
Get a scan campaign by id

Get a scan campaign by id

Request

Returns a single scan campaign for the target. The response shape matches items in the campaign collection, including links to configurations, findings, re-run, and the related job when present.

Security
bearer-key
Path
orgUuidstring, (uuid)required
applicationUuidstring, (uuid)required
projectUuidstring, (uuid)required
targetIdstring, (uuid)required
campaignIdstring, (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
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/{campaignId}?pretty=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Campaign

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.

responseobject(Campaign)required
Response
{
  "supportToken": "5bac741e-3f1c-4cd4-ad0d-a1492df0a5cc",
  "response": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
    "status": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "isRescan": true,
    "rootCampaignId": "189ae513-751f-4d72-88e5-bb996417cba0",
    "_links": { … }
  }
}