GET /katello/api/activation_keys
Mostrar llaves de activación

GET /katello/api/environments/:environment_id/activation_keys

GET /katello/api/organizations/:organization_id/activation_keys

Parámetros

Nombre del parámetro Descripción
organization_id
requerido

identificador de la organización

Validations:

  • Must be a number.

environment_id
opcional

identificador del entorno

Validations:

  • Must be a number.

content_view_id
opcional

identificador de vista de contenido

Validations:

  • Must be a number.

name
opcional

nombre de llave de activación utilizado para filtrar

Validations:

  • String

search
opcional

Buscar cadena

Validations:

  • String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

order
opcional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
opcional

Si se muestran o no todos los resultados

Validations:

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

sort
opcional

Versión de hash del parámetro 'orden'

Validations:

  • Hash

sort[by]
opcional

Campo en el que ordenar los resultados

Validations:

  • String

sort[order]
opcional

Cómo ordenar los resultados clasificados (p. ej., ASC para orden ascendente)

Validations:

  • String


POST /katello/api/activation_keys
Crear una llave de activación

Parámetros

Nombre del parámetro Descripción
organization_id
requerido

identificador de la organización

Validations:

  • Must be a number.

name
requerido

nombre

Validations:

  • String

description
opcional

descripción

Validations:

  • String

environment
opcional

entorno

Validations:

  • Hash

environment_id
opcional

ID de entorno

Validations:

  • Must be a number.

content_view_id
opcional

ID de vista de contenido

Validations:

  • Must be a number.

max_hosts
opcional

número máximo de hosts de contenido registrados

Validations:

  • Must be a number.

unlimited_hosts
opcional

can the activation key have unlimited hosts

Validations:

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


PUT /katello/api/activation_keys/:id
Actualizar una llave de activación

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

organization_id
requerido

identificador de la organización

Validations:

  • Must be a number.

name
opcional

nombre

Validations:

  • String

description
opcional

descripción

Validations:

  • String

environment_id
opcional

ID de entorno

Validations:

  • Must be a number.

content_view_id
opcional

ID de vista de contenido

Validations:

  • Must be a number.

max_hosts
opcional

número máximo de hosts de contenido registrados

Validations:

  • Must be a number.

unlimited_hosts
opcional

can the activation key have unlimited hosts

Validations:

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

release_version
opcional

versión de lanzamiento de contenido

Validations:

  • String

service_level
opcional

nivel de servicio

Validations:

  • String

auto_attach
opcional

Autovincular suscripciones tras el registro

Validations:

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


DELETE /katello/api/activation_keys/:id
Destruir una llave de activación

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.


GET /katello/api/activation_keys/:id
Mostrar una llave de activación

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

organization_id
opcional

identificador de la organización

Validations:

  • Must be a number.


POST /katello/api/activation_keys/:id/copy
Copiar llave de activación

Parámetros

Nombre del parámetro Descripción
new_name
requerido

Nombre de la nueva llave de activación

Validations:

  • String

id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

organization_id
opcional

identificador de la organización

Validations:

  • Must be a number.


GET /katello/api/activation_keys/:id/host_collections/available
List host collections the activation key does not belong to

Parámetros

Nombre del parámetro Descripción
search
opcional

Buscar cadena

Validations:

  • String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

order
opcional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
opcional

Si se muestran o no todos los resultados

Validations:

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

sort
opcional

Versión de hash del parámetro 'orden'

Validations:

  • Hash

sort[by]
opcional

Campo en el que ordenar los resultados

Validations:

  • String

sort[order]
opcional

Cómo ordenar los resultados clasificados (p. ej., ASC para orden ascendente)

Validations:

  • String

name
opcional

nombre de colección de hosts que va a filtrar

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
Mostrar versiones de lanzamiento disponibles para una llave de activación

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
Mostrar un contenido disponible para una llave de activación

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • String

content_access_mode_all
opcional

Get all content available, not just that provided by subscriptions

Validations:

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

content_access_mode_env
opcional

Limit content to just that available in the activation key's content view version

Validations:

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


POST /katello/api/activation_keys/:id/host_collections

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

host_collection_ids
requerido

Lista de ID de recopilación de hosts para asociar con la llave de activación

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/host_collections

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

host_collection_ids
requerido

Lista de ID de recopilación de hosts a disociar desde la llave de activación

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
Vincular una suscripción

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

subscription_id
opcional

Identificador de la suscripción

Validations:

  • Must be a number.

quantity
opcional

Cantidad de esta suscripción a agregar

Validations:

  • Must be a number.

subscriptions
opcional

Selección de suscripciones para añadir

Validations:

  • Must be an Array of nested elements

subscriptions[id]
opcional

UUID de grupo de suscripciones

Validations:

  • String

subscriptions[quantity]
opcional

Cantidad de estas suscripciones para añadir

Validations:

  • Must be a number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
Desvincular una suscripción

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

subscription_id
opcional

ID de suscripción

Validations:

  • String

subscriptions
opcional

Selección de suscripciones para añadir

Validations:

  • Must be an Array of nested elements

subscriptions[id]
opcional

UUID de grupo de suscripciones

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
Sobrescribir contenido para activation_key

Parámetros

Nombre del parámetro Descripción
id
requerido

ID de la llave de activación

Validations:

  • Must be a number.

content_override
opcional

Parámetros de sobrescritura de contenido

Validations:

  • Hash

content_override[content_label]
requerido

Etiqueta del contenido

Validations:

  • String

content_override[value]
requerido

Override to a boolean value or 'default'

Validations:

  • String

content_overrides
opcional

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
requerido

Etiqueta del contenido

Validations:

  • String

content_overrides[value]
opcional

Override value. Provide a boolean value if name is 'enabled'

Validations:

  • String

content_overrides[name]
opcional

Override parameter key or name. Note if name is not provided the default name will be 'enabled'

Validations:

  • String

content_overrides[remove]
opcional

Set true to remove an override and reset it to 'default'

Validations:

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