GetPortfolioStream

This method can be used for the following: Get details for a Portfolio Stream.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

GET /api/ss/portfolio/stream/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Identifier for the Portfolio Stream.

Example:

GET /api/ss/portfolio/stream/628f82669b462e581754980e HTTP/1.1

Example

The following example is a cURL request to get a Portfolio Stream by its identifier (Id).

Request

curl -X GET 'https://demo.attackforge.com/api/ss/portfolio/stream/628f82669b462e581754980e' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains a portfolio stream object.

{
  "stream" : {
    "id" : "...",
    "created" : "...",
    "modified" : "...",
    "name" : "...",
    "open_critical_vulnerabilities" : {
      "total": 999,
      "vulnerabilities": [
        {
          "id": "..."
        }
      ]
    },
    "open_high_vulnerabilities" : {
      "total": 999,
      "vulnerabilities": [
        {
          "id": "..."
        }
      ]
    },
    "open_info_vulnerabilities" : {
      "total": 999,
      "vulnerabilities": [
        {
          "id": "..."
        }
      ]
    },
    "open_low_vulnerabilities" : {
      "total": 999,
      "vulnerabilities": [
        {
          "id": "..."
        }
      ]
    },
    "open_medium_vulnerabilities" : {
      "total": 999,
      "vulnerabilities": [
        {
          "id": "..."
        }
      ]
    },
    "open_vulnerabilities" : {
      "total": 999,
      "vulnerabilities": [
        {
          "id": "..."
        }
      ]
    },
    "tags": [
      "..."
    ],
    "projects" : [
      {
        "id" : "...",
        "created" : "...",
        "modified" : "...",
        "name": "...",
        "code": "...",
        "start_date": "...",
        "end_date": "...",
        "status": "...",
        "groups" : [
          {
            "id": "...",
            "name": "..."
          }
        ],
        "open_critical_vulnerabilities" : {
          "total": 999,
          "vulnerabilities": [
            {
              "id": "..."
            }
          ]
        },
        "open_high_vulnerabilities" : {
          "total": 999,
          "vulnerabilities": [
            {
              "id": "..."
            }
          ]
        },
        "open_info_vulnerabilities" : {
          "total": 999,
          "vulnerabilities": [
            {
              "id": "..."
            }
          ]
        },
        "open_low_vulnerabilities" : {
          "total": 999,
          "vulnerabilities": [
            {
              "id": "..."
            }
          ]
        },
        "open_medium_vulnerabilities" : {
          "total": 999,
          "vulnerabilities": [
            {
              "id": "..."
            }
          ]
        },
        "open_vulnerabilities" : {
          "total": 999,
          "vulnerabilities": [
            {
              "id": "..."
            }
          ]
        }
      }
    ]
  }
}