Params

Param name Description
name
required

name

Validations:

  • String

organization_id
required

organization identifier

Validations:

  • Must be a number.

description
optional

description

Validations:

  • String

max_hosts
optional

maximum number of registered content hosts

Validations:

  • Must be a number.

unlimited_hosts
optional

can the activation key have unlimited hosts

Validations:

  • Must be one of: true, false, 1, 0.

release_version
optional

content release version

Validations:

  • String

service_level
optional

service level

Validations:

  • String

auto_attach DEPRECATED
optional

auto attach subscriptions upon registration

Validations:

  • Must be one of: true, false, 1, 0.

purpose_usage
optional

Sets the system purpose usage

Validations:

  • String

purpose_role
optional

Sets the system purpose usage

Validations:

  • String

purpose_addons
optional

Sets the system add-ons

Validations:

  • Must be an array of any type

environment DEPRECATED
optional

Hash containing the Id of the single lifecycle environment to be associated with the activation key.

Validations:

  • Hash

content_view_id
optional

Id of the single content view to be associated with the activation key.

Validations:

  • Integer

environment_id
optional

Id of the single lifecycle environment to be associated with the activation key.

Validations:

  • Integer

content_view_environments
optional

Comma-separated list of content view environment labels to be associated with the activation key, in the format of 'lifecycle_environment_label/content_view_label'. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.

Validations:

  • Must be an array of any type

content_view_environment_ids
optional

Array of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.

Validations:

  • Must be an array of any type