Skip to main content

List IoC profiles of a compromise family

GET
/compromised-host/campaigns/{id}/profiles

Linked IP addresses, domains, and URLs of the selected family with their role, protocols, and actual network replay method. Source values, confidence, and dates remain internal PTI metadata.

Contract

Parameter
Value
Sectioncompromised-host
AuthenticationCookieAuth
Consumesnot required
Producesapplication/json

Parameters

11 parameters

Name
Location
Required
Type
Description
idpathyesintegerIoC family ID
countqueryyesintegerRecords per page (10–100)
pagequeryyesintegerPage number, starting at 1
inputquerynostringSearch by IoC value, role, behavior, or protocol
typequerynostringComma-separated IoC types: ip, domain, url
rolequerynostringComma-separated roles: c2, payload_delivery
protocolquerynostringComma-separated protocols: dns, http, https, tcp
behaviorquerynostringComma-separated replay methods
exchangequerynostringComma-separated exchange templates: family, universal
keyquerynostringSort field: primaryArtifact, role, protocols, behavior, exchangeTemplate
orderquerynostringSort direction: asc or desc

Responses

5 responses

Status
Description
Type
200
Page of IoC profiles and the family summaryobject
400
Invalid ID, pagination, or filterobject
401
Unauthorizedobject
404
Family not foundobject
500
Failed to read or parse the family fileobject
  • {
      "cursor": {
        "count": 0,
        "currentPage": 0,
        "totalPages": 0,
        "totalRows": 0
      },
      "data": [
        {
          "artifacts": [
            {
              "derived": true,
              "port": 0,
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "behavior": "<string>",
          "exchangeTemplate": "<string>",
          "id": "<string>",
          "networkTemplateId": "<string>",
          "networkTemplateVariant": "<string>",
          "primaryArtifact": {
            "derived": true,
            "port": 0,
            "type": "<string>",
            "value": "<string>"
          },
          "protocols": [
            "<string>"
          ],
          "role": "<string>"
        }
      ],
      "summary": {
        "artifactCounts": {
          "<key>": 0
        },
        "behaviorCounts": {
          "<key>": 0
        },
        "exchangeCounts": {
          "<key>": 0
        },
        "profileCount": 0,
        "protocolCounts": {
          "<key>": 0
        },
        "roleCounts": {
          "<key>": 0
        },
        "scenarioCount": 0
      }
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }