Skip to content

security_advisory

Report and browse security advisories

Create

Path
POST /v7.0/security_advisories
Description
Create security advisory draft
Authentication required
yes
Scope
security_advisory#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
security_advisory
ParameterTypeRequiredDetails
name
Name
 String no

Optional well-known vulnerability name, e.g. Dirty Pipe.

Default: null
published_at
Published at
 Datetime no

Date and time shown as the advisory publication time.

Default: null
en_summary
English summary
 String yes

Short vulnerability-class title shown in advisory lists, status output, IRC announcements, 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_description
English description
 Text no

User-facing explanation of the vulnerability, affected systems, impact, and conditions.

Default: null
en_response
English response
 Text no

User-facing explanation of the mitigation or fix and whether users need to take action.

Default: null
cs_summary
Česky summary
 String yes

Short vulnerability-class title shown in advisory lists, status output, IRC announcements, 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_description
Česky description
 Text no

User-facing explanation of the vulnerability, affected systems, impact, and conditions.

Default: null
cs_response
Česky response
 Text no

User-facing explanation of the mitigation or fix and whether users need to take action.

Default: null
external_id
External_id
 String no

Stable idempotency key; retries return the existing advisory.

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
cve
Initial CVE
 String no

Optional CVE link created atomically with the draft.

Default: null

Output parameters

Layout
object
Namespace
security_advisory
ParameterTypeDescription
id
Id
 Integer
external_id
External_id
 String Stable external idempotency key for an advisory source.
state
State
 String
content_revision
Content_revision
 Integer
name
Name
 String Optional well-known vulnerability name, e.g. Dirty Pipe.
published_at
Published at
 Datetime Date and time shown as the advisory publication time.
en_summary
English summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
en_description
English description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
en_response
English response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
cs_summary
Česky summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
cs_description
Česky description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_response
Česky response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
affected
Affected
 Boolean True if the current user is affected by the advisory
affected_node_count
Affected nodes
 Integer
affected_user_count
Affected users
 Integer Number of affected users
affected_vps_count
Affected VPSes
 Integer
created_by
Created_by
 Resource
published_by
Published_by
 Resource
retracted_at
Retracted_at
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Index

Path
GET /v7.0/security_advisories
Description
List security advisories
Authentication required
no
Scope
security_advisory#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
security_advisory
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
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • draft
  • published
  • retracted

Validation error message: %{value} cannot be used
affected
Affected
 Boolean no

True if the current user is affected by the advisory

Default: null
cve
CVE
 String no

Optional CVE link created atomically with the draft.

Default: null
external_id
External_id
 String no

Filter by an exact external idempotency key.

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
recent_since
Recent_since
 Datetime no

Filter published or recently updated advisories

Default: null
user
User
 Resource no
vps
VPS
 Resource no
node
Node
 Resource no
since
Since
 Datetime no

Filter advisories created since specified date

Default: null
order
Order
 String no

Template order

Default: newest

Validation rules
RuleDetails
Include

Allowed values:

  • newest
  • oldest

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
security_advisories
ParameterTypeDescription
id
Id
 Integer
external_id
External_id
 String Stable external idempotency key for an advisory source.
state
State
 String
content_revision
Content_revision
 Integer
name
Name
 String Optional well-known vulnerability name, e.g. Dirty Pipe.
published_at
Published at
 Datetime Date and time shown as the advisory publication time.
en_summary
English summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
en_description
English description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
en_response
English response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
cs_summary
Česky summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
cs_description
Česky description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_response
Česky response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
affected
Affected
 Boolean True if the current user is affected by the advisory
affected_node_count
Affected nodes
 Integer
affected_user_count
Affected users
 Integer Number of affected users
affected_vps_count
Affected VPSes
 Integer
created_by
Created_by
 Resource
published_by
Published_by
 Resource
retracted_at
Retracted_at
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Publish

Path
POST /v7.0/security_advisories/{security_advisory_id}/publish
Description
Publish security advisory
Authentication required
yes
Scope
security_advisory#publish
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
security_advisory
ParameterTypeRequiredDetails
expected_content_revision
Expected_content_revision
 Integer yes

Publish only the exact draft revision shown during review.

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
send_mail
Send mail
 Boolean no

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

Default: false
published_at
Published at
 Datetime no

Date and time shown as the advisory publication time.

Default: null

Output parameters

Layout
object
Namespace
security_advisory
ParameterTypeDescription
id
Id
 Integer
external_id
External_id
 String Stable external idempotency key for an advisory source.
state
State
 String
content_revision
Content_revision
 Integer
name
Name
 String Optional well-known vulnerability name, e.g. Dirty Pipe.
published_at
Published at
 Datetime Date and time shown as the advisory publication time.
en_summary
English summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
en_description
English description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
en_response
English response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
cs_summary
Česky summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
cs_description
Česky description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_response
Česky response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
affected
Affected
 Boolean True if the current user is affected by the advisory
affected_node_count
Affected nodes
 Integer
affected_user_count
Affected users
 Integer Number of affected users
affected_vps_count
Affected VPSes
 Integer
created_by
Created_by
 Resource
published_by
Published_by
 Resource
retracted_at
Retracted_at
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Rebuild_affected_vps

Path
POST /v7.0/security_advisories/{security_advisory_id}/rebuild_affected_vps
Description
Rebuild affected VPS snapshot
Authentication required
yes
Scope
security_advisory#rebuild_affected_vps
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Show

Path
GET /v7.0/security_advisories/{security_advisory_id}
Description
Show security advisory details
Authentication required
no
Scope
security_advisory#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
security_advisory
ParameterTypeDescription
id
Id
 Integer
external_id
External_id
 String Stable external idempotency key for an advisory source.
state
State
 String
content_revision
Content_revision
 Integer
name
Name
 String Optional well-known vulnerability name, e.g. Dirty Pipe.
published_at
Published at
 Datetime Date and time shown as the advisory publication time.
en_summary
English summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
en_description
English description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
en_response
English response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
cs_summary
Česky summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
cs_description
Česky description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_response
Česky response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
affected
Affected
 Boolean True if the current user is affected by the advisory
affected_node_count
Affected nodes
 Integer
affected_user_count
Affected users
 Integer Number of affected users
affected_vps_count
Affected VPSes
 Integer
created_by
Created_by
 Resource
published_by
Published_by
 Resource
retracted_at
Retracted_at
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/security_advisories/{security_advisory_id}
Description
Update security advisory draft metadata
Authentication required
yes
Scope
security_advisory#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
security_advisory
ParameterTypeRequiredDetails
name
Name
 String no

Optional well-known vulnerability name, e.g. Dirty Pipe.

Default: null
published_at
Published at
 Datetime no

Date and time shown as the advisory publication time.

Default: null
en_summary
English summary
 String no

Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.

Default: null
en_description
English description
 Text no

User-facing explanation of the vulnerability, affected systems, impact, and conditions.

Default: null
en_response
English response
 Text no

User-facing explanation of the mitigation or fix and whether users need to take action.

Default: null
cs_summary
Česky summary
 String no

Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.

Default: null
cs_description
Česky description
 Text no

User-facing explanation of the vulnerability, affected systems, impact, and conditions.

Default: null
cs_response
Česky response
 Text no

User-facing explanation of the mitigation or fix and whether users need to take action.

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
security_advisory
ParameterTypeDescription
id
Id
 Integer
external_id
External_id
 String Stable external idempotency key for an advisory source.
state
State
 String
content_revision
Content_revision
 Integer
name
Name
 String Optional well-known vulnerability name, e.g. Dirty Pipe.
published_at
Published at
 Datetime Date and time shown as the advisory publication time.
en_summary
English summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
en_description
English description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
en_response
English response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
cs_summary
Česky summary
 String Short vulnerability-class title shown in advisory lists, status output, IRC announcements, and emails.
cs_description
Česky description
 Text User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_response
Česky response
 Text User-facing explanation of the mitigation or fix and whether users need to take action.
affected
Affected
 Boolean True if the current user is affected by the advisory
affected_node_count
Affected nodes
 Integer
affected_user_count
Affected users
 Integer Number of affected users
affected_vps_count
Affected VPSes
 Integer
created_by
Created_by
 Resource
published_by
Published_by
 Resource
retracted_at
Retracted_at
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Subresources