( Return to API Overview )

Available methods

listAllChannels
listManageableChannels
listMyChannels
listPopularChannels
listRedHatChannels
listRetiredChannels
listSharedChannels
listSoftwareChannels
listVendorChannels

Description

Provides method to get back a list of Software Channels.

Namespace: channel

Method: listAllChannels

Description:
List all software channels that the user's organization is entitled to.

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listManageableChannels

Description:
List all software channels that the user is entitled to manage.

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listMyChannels

Description:
List all software channels that belong to the user's organization.

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listPopularChannels

Description:
List the most popular software channels. Channels that have at least the number of systems subscribed as specified by the popularity count will be returned.

Parameters:

string sessionKey
int popularityCount

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listRedHatChannels

Description:
List all Red Hat software channels that the user's organization is entitled to.

Deprecated - being replaced by listVendorChannels(String sessionKey)

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listRetiredChannels

Description:
List all retired software channels. These are channels that the user's organization is entitled to, but are no longer supported because they have reached their 'end-of-life' date.

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listSharedChannels

Description:
List all software channels that may be shared by the user's organization.

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Method: listSoftwareChannels

Description:
List all visible software channels.

Parameters:

string sessionKey

Returns:

array: struct - channel string "label" string "name" string "parent_label" string "end_of_life" string "arch"

Method: listVendorChannels

Description:
Lists all the vendor software channels that the user's organization is entitled to.

Parameters:

string sessionKey

Returns:

array: struct - channel info int "id" string "label" string "name" string "provider_name" int "packages" int "systems" string "arch_name"

Generated on 3/4/2020