Skip to content

security_advisory.node_status

Security advisory node statuses

Create

Path
POST /v7.0/security_advisories/{security_advisory_id}/node_statuses
Description
Create advisory node status
Authentication required
yes
Scope
security_advisory.node_status#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
node_status
ParameterTypeRequiredDetails
node
Node
 Resource yes

Node whose exposure status is being recorded.
state
State
 String yes

Assessment of whether the node was affected and whether it has been mitigated.

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • not_affected
  • vulnerable
  • mitigated

Validation error message: %{value} cannot be used

Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
vulnerable_until
Vulnerable_until
 Datetime no

When vulnerability exposure ended on this node, if known.

Default: null
mitigated_since
Mitigated_since
 Datetime no

When the node was mitigated or patched, if known.

Default: null
en_note
English note
 Text no

Optional localized note for an exceptional circumstance on this node.

Default: null
cs_note
Česky note
 Text no

Optional localized note for an exceptional circumstance on this node.

Default: null
expected_content_revision
Expected_content_revision
 Integer yes

Apply the change only when the advisory has this content revision.

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
node_status
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource
node
Node
 Resource Node whose exposure status is being recorded.
state
State
 String Assessment of whether the node was affected and whether it has been mitigated.
vulnerable_until
Vulnerable_until
 Datetime When vulnerability exposure ended on this node, if known.
mitigated_since
Mitigated_since
 Datetime When the node was mitigated or patched, if known.
en_note
English note
 Text Optional localized note for an exceptional circumstance on this node.
cs_note
Česky note
 Text Optional localized note for an exceptional circumstance on this node.

Delete

Path
DELETE /v7.0/security_advisories/{security_advisory_id}/node_statuses/{node_status_id}
Description
Delete advisory node status
Authentication required
yes
Scope
security_advisory.node_status#delete
Aliases
destroy
Blocking
no

Input parameters

Layout
object
Namespace
node_status
ParameterTypeRequiredDetails
expected_content_revision
Expected_content_revision
 Integer yes

Apply the change only when the advisory has this content revision.

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

No parameters.

Index

Path
GET /v7.0/security_advisories/{security_advisory_id}/node_statuses
Description
List advisory node statuses
Authentication required
no
Scope
security_advisory.node_status#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
node_status
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
node
Node
 Resource no

Node whose exposure status is being recorded.
state
State
 String no

Assessment of whether the node was affected and whether it has been mitigated.

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • not_affected
  • vulnerable
  • mitigated

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
node_statuses
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource
node
Node
 Resource Node whose exposure status is being recorded.
state
State
 String Assessment of whether the node was affected and whether it has been mitigated.
vulnerable_until
Vulnerable_until
 Datetime When vulnerability exposure ended on this node, if known.
mitigated_since
Mitigated_since
 Datetime When the node was mitigated or patched, if known.
en_note
English note
 Text Optional localized note for an exceptional circumstance on this node.
cs_note
Česky note
 Text Optional localized note for an exceptional circumstance on this node.

Update

Path
PUT /v7.0/security_advisories/{security_advisory_id}/node_statuses/{node_status_id}
Description
Update advisory node status
Authentication required
yes
Scope
security_advisory.node_status#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
node_status
ParameterTypeRequiredDetails
state
State
 String no

Assessment of whether the node was affected and whether it has been mitigated.

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • unknown
  • not_affected
  • vulnerable
  • mitigated

Validation error message: %{value} cannot be used
vulnerable_until
Vulnerable_until
 Datetime no

When vulnerability exposure ended on this node, if known.

Default: null
mitigated_since
Mitigated_since
 Datetime no

When the node was mitigated or patched, if known.

Default: null
en_note
English note
 Text no

Optional localized note for an exceptional circumstance on this node.

Default: null
cs_note
Česky note
 Text no

Optional localized note for an exceptional circumstance on this node.

Default: null
expected_content_revision
Expected_content_revision
 Integer yes

Apply the change only when the advisory has this content revision.

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
node_status
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource
node
Node
 Resource Node whose exposure status is being recorded.
state
State
 String Assessment of whether the node was affected and whether it has been mitigated.
vulnerable_until
Vulnerable_until
 Datetime When vulnerability exposure ended on this node, if known.
mitigated_since
Mitigated_since
 Datetime When the node was mitigated or patched, if known.
en_note
English note
 Text Optional localized note for an exceptional circumstance on this node.
cs_note
Česky note
 Text Optional localized note for an exceptional circumstance on this node.