Update attack path risk

Updates an attack path as an accepted or unaccepted risk until a given time.

PUT /api/v2/attack-paths/{attack_path_id}/acceptance

Update attack path risk

cURL

curl --request PUT \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "risk_type": "<string>",
  "accept_until": "2023-11-07T05:31:56Z",
  "accepted": true
}
'

import requests

url = "https://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance"

payload = {
    "risk_type": "<string>",
    "accept_until": "2023-11-07T05:31:56Z",
    "accepted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({risk_type: '<string>', accept_until: '2023-11-07T05:31:56Z', accepted: true})
};

fetch('https://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance', 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://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'risk_type' => '<string>',
    'accept_until' => '2023-11-07T05:31:56Z',
    'accepted' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance"

	payload := strings.NewReader("{\n  \"risk_type\": \"<string>\",\n  \"accept_until\": \"2023-11-07T05:31:56Z\",\n  \"accepted\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"risk_type\": \"<string>\",\n  \"accept_until\": \"2023-11-07T05:31:56Z\",\n  \"accepted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-tenant.bloodhoundenterprise.io/api/v2/attack-paths/{attack_path_id}/acceptance")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"risk_type\": \"<string>\",\n  \"accept_until\": \"2023-11-07T05:31:56Z\",\n  \"accepted\": true\n}"

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

200

{
  "data": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": {
      "time": "2023-11-07T05:31:56Z",
      "valid": true
    },
    "Principal": "<string>",
    "PrincipalKind": "<string>",
    "Finding": "<string>",
    "DomainSID": "<string>",
    "Props": {},
    "AcceptedUntil": "2023-11-07T05:31:56Z",
    "ImpactPercentage": 123,
    "ImpactCount": 123
  }
}

{
  "http_status": 400,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The JSON payload could not be unmarshalled."
    }
  ]
}

{
  "http_status": 401,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "login",
      "message": "Unauthorized"
    }
  ]
}

{
  "http_status": 403,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "You do not have permission to access this resource"
    }
  ]
}

{
  "http_status": 404,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The requested client could not be found."
    }
  ]
}

{
  "http_status": 429,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "middleware",
      "message": "Too many requests. Please try again later."
    }
  ]
}

{
  "http_status": 500,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The request could not be handled due to an unexpected database error."
    }
  ]
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · string · default: wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

attack_path_id · integer<int64> · required

Attack Path ID

Body

application/json

The request body for updating risk acceptance

risk_type · string

accept_until · string<date-time>

accepted · boolean

Response

200

application/json

OK

data · object

Option 1

Option 2

Show child attributes