errata

Available methods

Description

Provides methods to access and modify errata.

Namespace:

errata

Method: addPackages

HTTP POST

Description:

Add a set of packages to an erratum with the given advisory name. This method will only allow for modification of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

  • int array packageIds

Returns:

  • int the number of packages added, exception otherwise

Method: applicableToChannels

HTTP GET

Description:

Returns a list of channels applicable to the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the list of channels applicable of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

    • struct channel

      • int "channel_id"

      • string "label"

      • string "name"

      • string "parent_channel_label"

Method: bugzillaFixes

HTTP POST

Description:

Get the Bugzilla fixes for an erratum matching the given advisoryName. The bugs will be returned in a struct where the bug id is the key. i.e. 208144="errata.bugzillaFixes Method Returns different results than docs say" For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the list of Bugzilla fixes of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • struct Bugzilla info

    • string "bugzilla_id" - actual bug number is the key into the struct

    • string "bug_summary" - summary who’s key is the bug id

Method: clone

HTTP POST

Description:

Clone a list of errata into the specified channel.

Parameters:

  • string sessionKey

  • string channelLabel

  • string array advisoryNames - the advisory names of the errata to clone

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: cloneAsOriginal

HTTP POST

Description:

Clones a list of errata into a specified cloned channel according the original erratas.

Parameters:

  • string sessionKey

  • string channelLabel

  • string array advisoryNames - the advisory names of the errata to clone

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: cloneAsOriginalAsync

HTTP POST

Description:

Asynchronously clones a list of errata into a specified cloned channel according the original erratas

Parameters:

  • string sessionKey

  • string channelLabel

  • string array advisoryNames - the advisory names of the errata to clone

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: cloneAsync

HTTP POST

Description:

Asynchronously clone a list of errata into the specified channel.

Parameters:

  • string sessionKey

  • string channelLabel

  • string array advisoryNames - the advisory names of the errata to clone

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: create

HTTP POST

Description:

Create a custom errata

Parameters:

  • string sessionKey

  • struct errataInfo

    • string "synopsis"

    • string "advisory_name"

    • int "advisory_release"

    • string "advisory_type" - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'

    • string "advisory_status" - Status of advisory (one of the following: 'final', 'testing', 'stable' or 'retracted'

    • string "product"

    • string "errataFrom"

    • string "topic"

    • string "description"

    • string "references"

    • string "notes"

    • string "solution"

    • string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate', 'Important', 'Critical' or 'Unspecified'

  • array bugs

    • struct bug

      • int "id" - Bug Id

      • string "summary"

      • string "url"

  • string array keywords - list of keywords to associate with the errata

  • int array packageIds

  • string array channelLabels - list of channels the errata should be published to

Returns:

  • * struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: delete

HTTP POST

Description:

Delete an erratum. This method will only allow for deletion of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: findByCve

HTTP GET

Description:

Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)

Parameters:

  • string sessionKey

  • string cveName

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: getDetails

HTTP GET

Description:

Retrieves the details for the erratum matching the given advisory name.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • struct erratum

    • int "id"

    • string "issue_date"

    • string "update_date"

    • string "last_modified_date" - last time the erratum was modified.

    • string "synopsis"

    • int "release"

    • string "advisory_status"

    • string "vendor_advisory"

    • string "type"

    • string "product"

    • string "errataFrom"

    • string "topic"

    • string "description"

    • string "references"

    • string "notes"

    • string "solution"

    • boolean "reboot_suggested" - A boolean flag signaling whether a system reboot is advisable following the application of the errata. Typical example is upon kernel update.

    • boolean "restart_suggested" - A boolean flag signaling a weather reboot of the package manager is advisable following the application of the errata. This is commonly used to address update stack issues before proceeding with other updates.

Method: listAffectedSystems

HTTP GET

Description:

Return the list of systems affected by the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the affected systems by both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

    • int "extra_pkg_count" - number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - number of out-of-date packages

Method: listCves

HTTP GET

Description:

Returns a list of CVEs applicable to the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the list of CVEs of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • string array CVE name

Method: listKeywords

HTTP GET

Description:

Get the keywords associated with an erratum matching the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the keywords of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • string array keyword associated with erratum.

Method: listPackages

HTTP GET

Description:

Returns a list of the packages affected by the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the packages of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

    • struct package

      • int "id"

      • string "name"

      • string "epoch"

      • string "version"

      • string "release"

      • string "arch_label"

      • string array "providing_channels" - - Channel label providing this package.

      • string "build_host"

      • string "description"

      • string "checksum"

      • string "checksum_type"

      • string "vendor"

      • string "summary"

      • string "cookie"

      • string "license"

      • string "path"

      • string "file"

      • string "build_date"

      • string "last_modified_date"

      • string "size"

      • string "payload_size"

Method: publish

HTTP POST

Description:

Adds an existing errata to a set of channels.

Parameters:

  • string sessionKey

  • string advisoryName

  • string array channelLabels - list of channel labels to add to

Returns:

  • * struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: publishAsOriginal

HTTP POST

Description:

Adds an existing cloned errata to a set of cloned channels according to its original erratum

Parameters:

  • string sessionKey

  • string advisoryName

  • string array channelLabels - list of channel labels to add to

Returns:

  • * struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: removePackages

HTTP POST

Description:

Remove a set of packages from an erratum with the given advisory name. This method will only allow for modification of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

  • int array packageIds

Returns:

  • int the number of packages removed, exception otherwise

Method: setDetails

HTTP POST

Description:

Set erratum details. All arguments are optional and will only be modified if included in the struct. This method will only allow for modification of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

  • struct details

    • string "synopsis"

    • string "advisory_name"

    • int "advisory_release"

    • string "advisory_type" - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'

    • string "product"

    • dateTime.iso8601 "issue_date"

    • dateTime.iso8601 "update_date"

    • string "errataFrom"

    • string "topic"

    • string "description"

    • string "references"

    • string "notes"

    • string "solution"

    • string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate', 'Important', 'Critical' or 'Unspecified'

    • array "bugs" - 'bugs' is the key into the struct

      • struct bug

        • int "id" - Bug Id

        • string "summary"

        • string "url"

    • string array "keywords" - list of keywords to associate with the errata

    • string array "cves" - list of CVEs to associate with the errata

Returns:

  • int - 1 on success, exception thrown otherwise.