Skip to main content
POST
Create impairment event

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

Input payload for Radar-originated impairment events.

external_event_id
string
required
Maximum string length: 255
scope
enum<string>
required
  • node - Node
  • pod - Pod
Available options:
node,
pod
source
enum<string>
default:radar
  • radar - Radar
Available options:
radar
reason
string
default:""
Maximum string length: 255
details
object

Opaque Radar-provided impairment metadata keyed by detail name.

instance_id
string | null
default:""
Maximum string length: 255
device_ids
string<uuid>[]
topology_group_id
string<uuid> | null

Response

Response shape for impairment events.

id
string<uuid>
required
read-only
source
enum<string>
required
  • radar - Radar
Available options:
radar
external_event_id
string
required
read-only
scope
enum<string>
required
  • node - Node
  • pod - Pod
Available options:
node,
pod
status
enum<string>
required
  • accepted - Accepted
  • cordoned - Cordoned
  • release_pending - Release Pending
  • release_retrying - Release Retrying
  • release_failed - Release Failed
  • partially_failed - Partially Failed
  • failed - Failed
  • cleared - Cleared
Available options:
accepted,
cordoned,
release_pending,
release_retrying,
release_failed,
partially_failed,
failed,
cleared
reason
string
required
read-only
details
object
required

Opaque Radar-provided impairment metadata keyed by detail name.

clear_details
object
required

Opaque Radar-provided impairment metadata keyed by detail name.

instance_id
string
required
read-only
requested_device_id
string<uuid> | null
required
read-only
topology_group_id
string<uuid> | null
required
read-only
devices
object[]
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
cleared_at
string<date-time> | null
required
read-only
clear_reason
string
Maximum string length: 255