Get risk register by ID - Vanta Developer Hub

GET

/

risk-registers

/

{riskRegisterId}

Get risk register by ID

curl --request GET \
  --url https://api.vanta.com/v1/risk-registers/{riskRegisterId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.vanta.com/v1/risk-registers/{riskRegisterId}', 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/risk-registers/{riskRegisterId}",
  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/risk-registers/{riskRegisterId}"

	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/risk-registers/{riskRegisterId}")

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

{
  "id": "5f2c939a52855e725c8d5824",
  "name": "Default",
  "description": null,
  "registerType": "SCOPED",
  "creationDate": "2024-03-07T18:46:05.944Z",
  "settings": {
    "applicableCustomFields": [
      "Business unit"
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

riskRegisterId

string

required

Response

200 - application/json

Ok

A risk register — a grouping of risk scenarios.

Risk scenarios reference their register by name (the riskRegister field on CreateRiskScenarioInput and RiskScenario). Domains with multiple registers must specify a register name on create.

id

string

required

The unique ID of the risk register.

name

string

required

The name of the risk register. This is the value used in the riskRegister field on risk-scenario create and update requests.

description

string | null

required

Optional description of this register.

registerType

enum<string>

required

Whether this is a scoped user-managed register or the system-managed enterprise register.

Available options:

SCOPED,

ENTERPRISE

creationDate

string<date-time>

required

When this risk register was created.

settings

object

required

Configuration that applies to the risk scenarios in this register.

Show child attributes

⌘I

Get risk register by ID

curl --request GET \
  --url https://api.vanta.com/v1/risk-registers/{riskRegisterId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.vanta.com/v1/risk-registers/{riskRegisterId}', 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/risk-registers/{riskRegisterId}",
  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/risk-registers/{riskRegisterId}"

	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/risk-registers/{riskRegisterId}")

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

{
  "id": "5f2c939a52855e725c8d5824",
  "name": "Default",
  "description": null,
  "registerType": "SCOPED",
  "creationDate": "2024-03-07T18:46:05.944Z",
  "settings": {
    "applicableCustomFields": [
      "Business unit"
    ]
  }
}