List vendor security incident alerts

GET

vendor-security-incident-alerts

curl --request GET \
  --url https://api.vanta.com/v1/vendor-security-incident-alerts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/vendor-security-incident-alerts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/vendor-security-incident-alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vanta.com/v1/vendor-security-incident-alerts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/vendor-security-incident-alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "results": {
    "data": [
      {
        "id": "<string>",
        "resolutionState": "OPEN",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "affectedVendorIds": [
          "<string>"
        ],
        "relatedVendorIds": [
          "<string>"
        ],
        "status": "POTENTIAL",
        "title": "<string>",
        "rootCause": "UNSPECIFIED",
        "threatActor": {
          "name": "<string>"
        },
        "evidence": [
          {
            "id": "<string>",
            "type": "PUBLIC_URL_EVIDENCE",
            "contentCategory": "SEC",
            "url": "<string>"
          }
        ],
        "impact": {
          "severity": "UNSPECIFIED",
          "context": "<string>",
          "affectedParties": [
            "CUSTOMERS"
          ],
          "dataLeakStatus": "UNSPECIFIED",
          "consequences": [
            {
              "type": "DENIAL_OF_SERVICE"
            }
          ]
        },
        "timeline": [
          {
            "type": "INITIAL_ACCESS",
            "occurredAt": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "pageInfo": {
      "endCursor": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize

integer<int32>

default:10

Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor

string

A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.

string

Case-insensitive search on alert title and affected vendor name.

vendorIdMatchesAny

string[]

Organization vendor IDs.

Required array length: 1 - 20 elements

resolutionStateMatchesAny

enum<string>[]

Filter by resolution state. Returns alerts matching any of the specified states.

Minimum array length: 1

Available options:

OPEN,

RESOLVED

confirmationStatusMatchesAny

enum<string>[]

Filter by incident confirmation status. Returns alerts matching any of the specified statuses.

Minimum array length: 1

Available options:

POTENTIAL,

CONFIRMED,

SUSPECTED

impactSeverityMatchesAny

enum<string>[]

Filter by overall impact severity. Returns alerts matching any of the specified severities.

Minimum array length: 1

Available options:

UNSPECIFIED,

CRITICAL,

HIGH,

MEDIUM,

LOW

dataLeakSeverityMatchesAny

enum<string>[]

Matches a DATA_LEAK consequence's severity, independently of overall impact.

Minimum array length: 1

Available options:

UNSPECIFIED,

CRITICAL,

HIGH,

MEDIUM,

LOW

sort

enum<string>

default:creationDate

Available options:

creationDate,

impactSeverity,

resolutionState,

confirmationStatus

direction

enum<string>

default:desc

Ascending means oldest first, highest impact first (CRITICAL to LOW to UNSPECIFIED), OPEN before RESOLVED, or CONFIRMED before SUSPECTED before POTENTIAL. Descending reverses each order.

Available options:

asc,

desc

Response

200 - application/json

results

object

required

Show child attributes

⌘I

List vendor security incident alerts

curl --request GET \
  --url https://api.vanta.com/v1/vendor-security-incident-alerts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/vendor-security-incident-alerts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/vendor-security-incident-alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vanta.com/v1/vendor-security-incident-alerts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/vendor-security-incident-alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "results": {
    "data": [
      {
        "id": "<string>",
        "resolutionState": "OPEN",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "affectedVendorIds": [
          "<string>"
        ],
        "relatedVendorIds": [
          "<string>"
        ],
        "status": "POTENTIAL",
        "title": "<string>",
        "rootCause": "UNSPECIFIED",
        "threatActor": {
          "name": "<string>"
        },
        "evidence": [
          {
            "id": "<string>",
            "type": "PUBLIC_URL_EVIDENCE",
            "contentCategory": "SEC",
            "url": "<string>"
          }
        ],
        "impact": {
          "severity": "UNSPECIFIED",
          "context": "<string>",
          "affectedParties": [
            "CUSTOMERS"
          ],
          "dataLeakStatus": "UNSPECIFIED",
          "consequences": [
            {
              "type": "DENIAL_OF_SERVICE"
            }
          ]
        },
        "timeline": [
          {
            "type": "INITIAL_ACCESS",
            "occurredAt": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "pageInfo": {
      "endCursor": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>"
    }
  }
}

API Basics

Manage API

Integrations API

Audit API

Webhooks

List vendor security incident alerts

Authorizations

Query Parameters

Response