Get Enclave Tags For Report

GET /1.2/reports/{id}/enclave-tags?idType={id_type}

Description

Returns the list of enclave tags (name, enclave id) that a report has been tagged with

Parameters

Parameter Required Description
id X TruSTAR report id or external tracking id
idType   internal or external (defaults to internal when not provided)

Responses

200 (OK)

[
    {
        "guid": enclave tag guid,
        "name": tag name,
        "count": number of times the tag has been applied,
        "enclaveId": id of the enclave the tag belongs to
    }
]

An array of enclave tag objects.

400 (Bad Request)

{
    "timestamp": milliseconds since epoc,
    "status": 400,
    "error": "Bad Request",
    "message": error detail (e.g. id not provided)
}

403 (Forbidden)

{
    "timestamp": milliseconds since epoc,
    "status": 400,
    "error":" Bad Request",
    "message": error detail (e.g. user cannot access report)
}

404 (Not Found)

{
    "timestamp": milliseconds since epoc,
    "status": 404,
    "error": "Not Found",
    "message": error detail (e.g. report not found)
}

Example Usage

Request

curl -k -H "Authorization: Bearer {access_token}" "https://api.trustar.co/api/1.2/reports/9066ab40-2f3c-45ae-9566-7530403da691/enclave-tags"

Response

[
    {
        "guid": "368561e2-81ba-4efa-a46d-a306ad23932e",
        "name": "malware",
        "count": 1,
        "enclaveId": "2884f4b2-1781-4641-aa54-8911d32bd323"
    },
    {
        "guid": "fe695fc1-068a-4489-9495-f50c509b0532",
        "name": "spearphish",
        "count": 1,
        "enclaveId": "2884f4b2-1781-4641-aa54-8911d32bd323"
    }
]