Class: Infrawrench::BlastRadiusNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.blast_radius

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ BlastRadiusNamespace

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BlastRadiusNamespace.

Parameters:



2389
2390
2391
 
# File 'lib/infrawrench/client.rb', line 2389

def initialize(transport)
  @transport = transport
end

Instance Method Details

#get(resource_id:, org_id: nil, request_options: nil) ⇒ Hash

What breaks if this resource is deleted

An impact report for one resource, assembled from the dependency graph walked inbound, network flow attribution, and the org objects that name the resource without depending on it (dashboards, custom graphs, probes, status pages, metric alerts, leases, schedules, saved log queries, workflows, and its recorded owner).

The endpoint answers 200 with a partial report rather than failing when a source is unavailable; unchecked says which, in prose.

Requires permission: resources:read.

GET /api/org/orgId/blast-radius

Raises on 400: Missing resourceId

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • resource_id (Hash)
  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • resource_id: (resource_id & untyped)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as BlastRadiusReport — see sig/infrawrench/sdk.rbs.

Raises:



2416
2417
2418
2419
2420
2421
2422
2423
2424
 
# File 'lib/infrawrench/client.rb', line 2416

def get(resource_id:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/blast-radius",
    path_params: { "orgId" => org_id },
    query: { "resourceId" => resource_id },
    request_options: request_options
  )
end