Class: Infrawrench::StatusIncidentsNamespace

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

Overview

client.status_incidents

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ StatusIncidentsNamespace

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 StatusIncidentsNamespace.

Parameters:



7184
7185
7186
 
# File 'lib/infrawrench/client.rb', line 7184

def initialize(transport)
  @transport = transport
end

Instance Method Details

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

Provider incidents overlapping your resources

The "is it me or is it them?" feed. The poller watches each provider plugin's public status feed (declared on its manifest — zero credentials, zero rate-limit risk), caches active incidents, and this endpoint correlates them against the resources the organization holds: an incident matches a resource when it is provider-wide, names the resource's region, or names its resource type. Includes incidents resolved within the last 24 hours so recent drift can still be correlated. Active incidents first, most severe first.

Requires permission: resources:read.

GET /api/org/orgId/status-incidents

Raises on 400: Bad request

Parameters:

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

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



7211
7212
7213
7214
7215
7216
7217
7218
 
# File 'lib/infrawrench/client.rb', line 7211

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