GET /katello/api/activation_keys
Répertorier les clés d'activation

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

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

Paramètres

Nom du paramètre Description
organization_id
requis

identifiant de l'organisation

Validations:

  • number.

environment_id
optionel

identifiant d'environnement

Validations:

  • number.

content_view_id
optionel

identifiant d'affichage du contenu

Validations:

  • number.

name
optionel

Nom de la clé d'activation avec lequel filtrer

Validations:

  • String

search
optionel

Rechercher une chaîne

Validations:

  • String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • number.

order
optionel

Trier le champ et l'ordre, ex : 'name DESC'

Validations:

  • String

full_result
optionel

Afficher tous les résultats ou pas

Validations:

  • boolean

sort
optionel

Version Hash des paramètres d'« ordre »

Validations:

  • Hash

sort[by]
optionel

Champs dans lequel trier les résultats

Validations:

  • String

sort[order]
optionel

Comment classer les résultats triés (ex : ASC for ascending ou CRO pour croissant)

Validations:

  • String


POST /katello/api/activation_keys
Créer une clé d'activation

Paramètres

Nom du paramètre Description
organization_id
requis

identifiant de l'organisation

Validations:

  • number.

name
requis

nom

Validations:

  • String

description
optionel

description

Validations:

  • String

environment
optionel

environnement

Validations:

  • Hash

environment_id
optionel

id de l'environnement

Validations:

  • number.

content_view_id
optionel

ID de l'affichage de contenu

Validations:

  • number.

max_hosts
optionel

nombre maximum d'hôtes de contenu enregistrés

Validations:

  • number.

unlimited_hosts
optionel

can the activation key have unlimited hosts

Validations:

  • boolean


PUT /katello/api/activation_keys/:id
Mettre à jour une clé d'activation

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

organization_id
requis

identifiant de l'organisation

Validations:

  • number.

name
optionel

nom

Validations:

  • String

description
optionel

description

Validations:

  • String

environment_id
optionel

id de l'environnement

Validations:

  • number.

content_view_id
optionel

ID de l'affichage de contenu

Validations:

  • number.

max_hosts
optionel

nombre maximum d'hôtes de contenu enregistrés

Validations:

  • number.

unlimited_hosts
optionel

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
optionel

version du contenu

Validations:

  • String

service_level
optionel

niveau de service

Validations:

  • String

auto_attach
optionel

joindre automatiquement les abonnements lors de l'enregistrement

Validations:

  • boolean


DELETE /katello/api/activation_keys/:id
Détruire une clé d'activation

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.


GET /katello/api/activation_keys/:id
Afficher une clé d'activation

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

organization_id
optionel

identifiant de l'organisation

Validations:

  • number.


POST /katello/api/activation_keys/:id/copy
Copier une clé d'activation

Paramètres

Nom du paramètre Description
new_name
requis

Nom de la nouvelle clé d'activation

Validations:

  • String

id
requis

ID d'une clé d'activation

Validations:

  • number.

organization_id
optionel

identifiant de l'organisation

Validations:

  • number.


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

Paramètres

Nom du paramètre Description
search
optionel

Rechercher une chaîne

Validations:

  • String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • number.

order
optionel

Trier le champ et l'ordre, ex : 'name DESC'

Validations:

  • String

full_result
optionel

Afficher tous les résultats ou pas

Validations:

  • boolean

sort
optionel

Version Hash des paramètres d'« ordre »

Validations:

  • Hash

sort[by]
optionel

Champs dans lequel trier les résultats

Validations:

  • String

sort[order]
optionel

Comment classer les résultats triés (ex : ASC for ascending ou CRO pour croissant)

Validations:

  • String

name
optionel

nom de la collection d'hôte avec lequel filtrer

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
Afficher les versions disponibles pour une clé d'activation

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
Afficher le contenu disponible pour une clé d'activation

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • String

content_access_mode_all
optionel

Get all content available, not just that provided by subscriptions

Validations:

  • boolean

content_access_mode_env
optionel

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

Validations:

  • boolean


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

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

host_collection_ids
requis

Liste d'id de collection d'hôtes à associer à la clé d'activation

Validations:

  • Must be an array of any type


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

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

host_collection_ids
requis

Liste d'id de collection d'hôtes à dissocier de la clé d'activation

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
Attacher un abonnement

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

subscription_id
optionel

Identifiant d'abonnement

Validations:

  • number.

quantity
optionel

Nombre de ces abonnements à ajouter.

Validations:

  • number.

subscriptions
optionel

Ensemble d'abonnements à ajouter

Validations:

  • Must be an Array of nested elements

subscriptions[id]
optionel

Uuid de pool d'abonnement

Validations:

  • String

subscriptions[quantity]
optionel

Quantité de cet abonnement à ajouter

Validations:

  • number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
Détacher un abonnement

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

subscription_id
optionel

ID d'abonnement

Validations:

  • String

subscriptions
optionel

Ensemble d'abonnements à ajouter

Validations:

  • Must be an Array of nested elements

subscriptions[id]
optionel

Uuid de pool d'abonnement

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
Annuler le contenu pour la clé d'activation

Paramètres

Nom du paramètre Description
id
requis

ID d'une clé d'activation

Validations:

  • number.

content_override
optionel

Paramètres de remplacement de contenu

Validations:

  • Hash

content_override[content_label]
requis

Étiquette du contenu

Validations:

  • String

content_override[value]
requis

Override to a boolean value or 'default'

Validations:

  • String

content_overrides
optionel

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
requis

Étiquette du contenu

Validations:

  • String

content_overrides[value]
optionel

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

Validations:

  • String

content_overrides[name]
optionel

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

Validations:

  • String

content_overrides[remove]
optionel

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

Validations:

  • boolean