Skip to content

security_advisory_update

Browse security advisory updates

Create

Path
POST /v7.0/security_advisory_updates
Description
Create security advisory update
Authentication required
yes
Scope
security_advisory_update#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
security_advisory_update
ParameterTypeRequiredDetails
security_advisory
Security advisory
 Resource yes

Advisory to which this update belongs.
state
State
 String no

Optional advisory state change to apply with this update.

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • draft
  • published
  • retracted

Validation error message: %{value} cannot be used
en_summary
English summary
 String yes

One-sentence public summary of this update, shown in update lists and emails.

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
en_message
English message
 Text no

Optional user-facing message with more details about this update.

Default: null
cs_summary
Česky summary
 String yes

One-sentence public summary of this update, shown in update lists and emails.

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
cs_message
Česky message
 Text no

Optional user-facing message with more details about this update.

Default: null
published_at
Published at
 Datetime no

Date and time shown as the advisory publication time.

Default: null
send_mail
Send mail
 Boolean no

When enabled, affected users are emailed after the action completes.

Default: false

Output parameters

Layout
object
Namespace
security_advisory_update
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource Advisory to which this update belongs.
state
State
 String Optional advisory state change to apply with this update.
en_summary
English summary
 String One-sentence public summary of this update, shown in update lists and emails.
en_message
English message
 Text Optional user-facing message with more details about this update.
cs_summary
Česky summary
 String One-sentence public summary of this update, shown in update lists and emails.
cs_message
Česky message
 Text Optional user-facing message with more details about this update.
reported_by
Reported_by
 Resource
reporter_name
Reporter_name
 String
name
Name
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/security_advisory_updates/{security_advisory_update_id}
Description
Delete security advisory update
Authentication required
yes
Scope
security_advisory_update#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/security_advisory_updates
Description
List security advisory updates
Authentication required
no
Scope
security_advisory_update#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
security_advisory_update
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
security_advisory
Security advisory
 Resource no

Advisory to which this update belongs.
since
Since
 Datetime no

Default: null

Output parameters

Layout
object_list
Namespace
security_advisory_updates
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource Advisory to which this update belongs.
state
State
 String Optional advisory state change to apply with this update.
en_summary
English summary
 String One-sentence public summary of this update, shown in update lists and emails.
en_message
English message
 Text Optional user-facing message with more details about this update.
cs_summary
Česky summary
 String One-sentence public summary of this update, shown in update lists and emails.
cs_message
Česky message
 Text Optional user-facing message with more details about this update.
reported_by
Reported_by
 Resource
reporter_name
Reporter_name
 String
name
Name
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/security_advisory_updates/{security_advisory_update_id}
Description
Show security advisory update
Authentication required
no
Scope
security_advisory_update#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
security_advisory_update
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource Advisory to which this update belongs.
state
State
 String Optional advisory state change to apply with this update.
en_summary
English summary
 String One-sentence public summary of this update, shown in update lists and emails.
en_message
English message
 Text Optional user-facing message with more details about this update.
cs_summary
Česky summary
 String One-sentence public summary of this update, shown in update lists and emails.
cs_message
Česky message
 Text Optional user-facing message with more details about this update.
reported_by
Reported_by
 Resource
reporter_name
Reporter_name
 String
name
Name
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/security_advisory_updates/{security_advisory_update_id}
Description
Update security advisory update text
Authentication required
yes
Scope
security_advisory_update#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
security_advisory_update
ParameterTypeRequiredDetails
en_summary
English summary
 String yes

One-sentence public summary of this update, shown in update lists and emails.

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
en_message
English message
 Text no

Optional user-facing message with more details about this update.

Default: null
cs_summary
Česky summary
 String yes

One-sentence public summary of this update, shown in update lists and emails.

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
cs_message
Česky message
 Text no

Optional user-facing message with more details about this update.

Default: null

Output parameters

Layout
object
Namespace
security_advisory_update
ParameterTypeDescription
id
Id
 Integer
security_advisory
Security advisory
 Resource Advisory to which this update belongs.
state
State
 String Optional advisory state change to apply with this update.
en_summary
English summary
 String One-sentence public summary of this update, shown in update lists and emails.
en_message
English message
 Text Optional user-facing message with more details about this update.
cs_summary
Česky summary
 String One-sentence public summary of this update, shown in update lists and emails.
cs_message
Česky message
 Text Optional user-facing message with more details about this update.
reported_by
Reported_by
 Resource
reporter_name
Reporter_name
 String
name
Name
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime