image

Available methods

Description

Provides methods to access and modify images.

Namespace:

image

Method: addImageFile

HTTP POST

Description:

Delete image file

Parameters:

  • string sessionKey

  • int imageId - ID of the image

  • string file - the file name, it must exist in the store

  • string type - the image type

  • boolean external - the file is external

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: delete

HTTP POST

Description:

Delete an image

Parameters:

  • string sessionKey

  • int imageId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteImageFile

HTTP POST

Description:

Delete image file

Parameters:

  • string sessionKey

  • int imageId - ID of the image

  • string file - the file name

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getCustomValues

HTTP GET

Description:

Get the custom data values defined for the image

Parameters:

  • string sessionKey

  • int imageId

Returns:

  • struct the map of custom labels to custom values

    • string "custom info label"

    • string "value"

Method: getDetails

HTTP GET

Description:

Get details of an image

Parameters:

  • string sessionKey

  • int imageId

Returns:

  • * struct image overview information

    • int "id"

    • string "name" - image name

    • string "type" - image type

    • string "version" - image tag/version

    • int "revision" - image build revision number

    • string "arch" - image architecture

    • boolean "external" - true if the image is built externally, false otherwise

    • string "checksum"

    • string "profileLabel"

    • string "storeLabel"

    • string "buildStatus" - One of:

      • queued

      • picked up

      • completed

      • failed

    • string "inspectStatus" - Available if the build is successful. One of:

      • queued

      • picked up

      • completed

      • failed

    • int "buildServerId"

    • int "securityErrata"

    • int "bugErrata"

    • int "enhancementErrata"

    • int "outdatedPackages"

    • int "installedPackages"

    • struct "files" - image files

    • boolean "obsolete" - true if the image has been replaced in the store

Method: getPillar

HTTP GET

Description:

Get pillar data of an image. The "size" entries are converted to string.

Parameters:

  • string sessionKey

  • int imageId

Returns:

  • struct the pillar data

Method: getRelevantErrata

HTTP GET

Description:

Returns a list of all errata that are relevant for the image

Parameters:

  • string sessionKey

  • int imageId

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

    • 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: importContainerImage

HTTP POST

Description:

Import an image and schedule an inspect afterwards

Parameters:

  • string sessionKey

  • string name - image name as specified in the store

  • string version - version to import or empty

  • int buildHostId - system ID of the build host

  • string storeLabel

  • string activationKey - activation key to get the channel data from

  • dateTime.iso8601 earliestOccurrence - earliest the following inspect can run

Returns:

  • int the ID of the inspect action created

Method: importImage (Deprecated)

HTTP POST

Description:

Import an image and schedule an inspect afterwards

Deprecated - Schedule a Container image import

Parameters:

  • string sessionKey

  • string name - image name as specified in the store

  • string version - version to import or empty

  • int buildHostId - system ID of the build host

  • string storeLabel

  • string activationKey - activation key to get the channel data from

  • dateTime.iso8601 earliestOccurrence - earliest the following inspect can run

Returns:

  • int the ID of the inspect action created

Method: importOSImage

HTTP POST

Description:

Import an image and schedule an inspect afterwards

Parameters:

  • string sessionKey

  • string name - image name as specified in the store

  • string version - version to import

  • string arch - image architecture

Returns:

  • int the ID of the image

Method: listImages

HTTP GET

Description:

List available images

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct image information

    • int "id"

    • string "name" - image name

    • string "version" - image tag/version

    • int "revision" - image build revision number

    • string "arch" - image architecture

    • boolean "external" - true if the image is built externally, false otherwise

    • string "storeLabel"

    • string "checksum"

    • string "obsolete"

Method: listPackages

HTTP GET

Description:

List the installed packages on the given image

Parameters:

  • string sessionKey

  • int imageId

Returns:

  • array :

    • struct package

      • string "name"

      • string "version"

      • string "release"

      • string "epoch"

      • string "arch"

Method: scheduleImageBuild

HTTP POST

Description:

Schedule an image build

Parameters:

  • string sessionKey

  • string profileLabel

  • string version - version to build or empty

  • int buildHostId - system id of the build host

  • dateTime.iso8601 earliestOccurrence - earliest the build can run.

Returns:

  • int the ID of the build action created

Method: setPillar

HTTP POST

Description:

Set pillar data of an image. The "size" entries should be passed as string.

Parameters:

  • string sessionKey

  • int imageId

  • struct pillarData

Returns:

  • int - 1 on success, exception thrown otherwise.