( Return to API Overview )
Description
Contains methods to access common activation key functions available from the web interface.
Namespace:
activationkey
Description:
Add child channels to an activation key.
Parameters:
- string sessionKey
- string key
- array
Returns:
int - 1 on success.
Description:
Given a list of activation keys and configuration channels, this method appends the configuration channels to either the top or the bottom (whichever you specify) of an activation key's configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list already exists in an activation key, the configuration channel will be re-ranked to the appropriate place.
Parameters:
- string sessionKey
- array
- array
- string configChannelLabel
- boolean addToTop,
- If true, will prepend the given channels to the beginning of the activation key's config channel list
- If false will append the given channels to the end of the activation key's config channel list
Returns:
int - 1 on success.
Description:
Add entitlements to an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform)
Parameters:
- string sessionKey
- string key
- array
- string entitlementLabel - Entitlement string label to be added.
Returns:
int - 1 on success.
Description:
Add package names to an activation key.
Parameters:
- string sessionKey
- string key
- array
Returns:
int - 1 on success.
Description:
Add server groups to an activation key.
Parameters:
- string sessionKey
- string key
- array
Returns:
int - 1 on success.
Description:
Create a new activation key. The activation key parameter passed in will be prefixed with the organization ID, and this value will be returned from the create call. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100, the actual activation key will be "100-foo". This call allows for the setting of a usage limit on this activation key. If unlimited usage is desired see the similarly named API method with no usage limit argument.
Parameters:
- string sessionKey
- string key - Leave empty to have new key autogenerated.
- string description
- string baseChannelLabel - Leave empty to accept default.
- int usageLimit leave blank for unlimited.
- array - Add on entitlement labels to associate with the key.
- boolean universalDefault
Returns:
string - The new activation key.
Description:
Create a new activation key with unlimited usage. The activation key parameter passed in will be prefixed with the organization ID, and this value will be returned from the create call. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100, the actual activation key will be "100-foo".
Parameters:
- string sessionKey
- string key - Leave empty to have new key autogenerated.
- string description
- string baseChannelLabel - Leave empty to accept default.
- array - Add on entitlement labels to associate with the key.
- boolean universalDefault
Returns:
string - The new activation key.
Description:
Delete an activation key.
Parameters:
- string sessionKey
- string key
Returns:
int - 1 on success.
Description:
Lookup an activation key's details.
Parameters:
- string sessionKey
- string key
Returns:
struct (activation key) - string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- array "entitlements"
- array "server_group_ids"
- array "package_names"
- boolean "universal_default"
Description:
List activation keys that are visible to the user.
Parameters:
Returns:
array - struct (activation key)
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- array "entitlements"
- array "server_group_ids"
- array "package_names"
- boolean "universal_default"
Description:
List configuration channels associated to an activation key.
Parameters:
- string sessionKey
- string key
Returns:
array - struct (config channel)
- int "id" - Config channel ID.
- string "label" - Config channel label.
- string "name" - Config channel name.
- string "description"
- int "org_id"
- struct (config channel type)
- int "id"
- string "label"
- string "name"
- string "priority"
Description:
Remove child channels from an activation key.
Parameters:
- string sessionKey
- string key
- array
Returns:
int - 1 on success.
Description:
Remove configuration channels from the given activation keys.
Parameters:
- string sessionKey
- array
- array
- string configChannelLabel
Returns:
int - 1 on success.
Description:
Remove entitlements from an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform)
Parameters:
- string sessionKey
- string key
- array
- string entitlement - Entitlement string labels to be removed.
Returns:
int - 1 on success.
Description:
Remove package names from an activation key.
Parameters:
- string sessionKey
- string key
- array
Returns:
int - 1 on success.
Description:
Remove server groups from an activation key.
Parameters:
- string sessionKey
- string key
- array
Returns:
int - 1 on success.
Description:
Replace the existing set of configuration channels on the given activation keys. Channels are ranked by their order in the array.
Parameters:
- string sessionKey
- array
- array
- string configChannelLabel
Returns:
int - 1 on success.
Description:
Update the details of an activation key.
Parameters:
- string sessionKey
- string key
- struct (activation key)
- string "description"
- string "base_channel_label"
- int "usage_limit"
- boolean "unlimited_usage_limit" - If set to true, "usage_limit" will be ignored and the key will receive unlimited usage.
- boolean "universal_default"
Returns:
int - 1 on success.