sync.content

Description

Provides the namespace for the content synchronization methods.

Namespace:

sync.content

Method: addChannel

HTTP POST

Description:

Add a new channel to the #product() database

Parameters:

  • string sessionKey - Session token, issued at login

  • string channelLabel - Label of the channel to add

  • string mirrorUrl - Sync from mirror temporarily

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addChannels

HTTP POST

Description:

Add a new channel to the #product() database

Parameters:

  • string sessionKey - Session token, issued at login

  • string channelLabel - Label of the channel to add

  • string mirrorUrl - Sync from mirror temporarily

Returns:

  • string array enabled channel labels

Method: addCredentials

HTTP POST

Description:

Add organization credentials (mirror credentials) to #product().

Parameters:

  • string sessionKey - Session token, issued at login

  • string username - Organization credentials (Mirror credentials) username

  • string password - Organization credentials (Mirror credentials) password

  • boolean primary - Make this the primary credentials

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteCredentials

HTTP POST

Description:

Delete organization credentials (mirror credentials) from #product().

Parameters:

  • string sessionKey - Session token, issued at login

  • string username - Username of credentials to delete

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listChannels

HTTP GET

Description:

List all accessible channels.

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • array :

  • struct channel

    • string "arch" - architecture of the channel

    • string "description" - description of the channel

    • string "family" - channel family label

    • boolean "is_signed" - channel has signed metadata

    • string "label" - label of the channel

    • string "name" - name of the channel

    • boolean "optional" - channel is optional

    • string "parent" - the label of the parent channel

    • string "product_name" - product name

    • string "product_version" - product version

    • string "source_url" - repository source URL

    • string "status" - 'available', 'unavailable' or 'installed'

    • string "summary" - channel summary

    • string "update_tag" - update tag

    • boolean "installer_updates" - is an installer update channel

Method: listCredentials

HTTP GET

Description:

List organization credentials (mirror credentials) available in #product().

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • array :

  • struct credentials

    • int "id" - ID of the credentials

    • string "user" - username

    • boolean "isPrimary" - primary

Method: listProducts

HTTP GET

Description:

List all accessible products.

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • array :

  • struct product

    • string "friendly_name" - friendly name of the product

    • string "arch" - architecture

    • string "status" - 'available', 'unavailable' or 'installed'

    • array "channels"

  • struct channel

    • string "arch" - architecture of the channel

    • string "description" - description of the channel

    • string "family" - channel family label

    • boolean "is_signed" - channel has signed metadata

    • string "label" - label of the channel

    • string "name" - name of the channel

    • boolean "optional" - channel is optional

    • string "parent" - the label of the parent channel

    • string "product_name" - product name

    • string "product_version" - product version

    • string "source_url" - repository source URL

    • string "status" - 'available', 'unavailable' or 'installed'

    • string "summary" - channel summary

    • string "update_tag" - update tag

    • boolean "installer_updates" - is an installer update channel

    • array "extensions"

      • struct extension product

        • string "friendly_name" - friendly name of extension product

        • string "arch" - architecture

        • string "status" - 'available', 'unavailable' or 'installed'

        • array "channels"

  • struct channel

    • string "arch" - architecture of the channel

    • string "description" - description of the channel

    • string "family" - channel family label

    • boolean "is_signed" - channel has signed metadata

    • string "label" - label of the channel

    • string "name" - name of the channel

    • boolean "optional" - channel is optional

    • string "parent" - the label of the parent channel

    • string "product_name" - product name

    • string "product_version" - product version

    • string "source_url" - repository source URL

    • string "status" - 'available', 'unavailable' or 'installed'

    • string "summary" - channel summary

    • string "update_tag" - update tag

    • boolean "installer_updates" - is an installer update channel

    • boolean "recommended" - recommended

Method: synchronizeChannelFamilies

HTTP POST

Description:

Synchronize channel families between the Customer Center and the #product() database.

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: synchronizeChannels

HTTP POST

Description:

(Deprecated) Synchronize channels between the Customer Center and the #product() database.

Parameters:

  • string sessionKey - Session token, issued at login

  • string mirrorUrl - Sync from mirror temporarily

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: synchronizeProducts

HTTP POST

Description:

Synchronize SUSE products between the Customer Center and the #product() database.

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: synchronizeRepositories

HTTP POST

Description:

Synchronize repositories between the Customer Center and the #product() database.

Parameters:

  • string sessionKey - Session token, issued at login

  • string mirrorUrl - Optional mirror url or null

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: synchronizeSubscriptions

HTTP POST

Description:

Synchronize subscriptions between the Customer Center and the #product() database.

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • int - 1 on success, exception thrown otherwise.