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

Params

Param Name Description
organization_id
Required

identifiant de l'organisation

Validations:

  • number.

environment_id
Optional

identifiant d'environnement

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_id
Optional

identifiant d'affichage du contenu

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

name
Optional

Nom de la clé d'activation avec lequel filtrer

Validations:

  • String

search
Optional

Rechercher une chaîne

Validations:

  • String

page
Optional

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

Validations:

  • number.

per_page
Optional

Nombre de résultats par page à renvoyer

Validations:

  • number.

order
Optional

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

Validations:

  • String

full_results
Optional

Afficher tous les résultats ou pas

Validations:

  • boolean

sort
Optional

Version Hash des paramètres d'« ordre »

Validations:

  • Hash

sort[by]
Optional

Champs dans lequel trier les résultats

Validations:

  • String

sort[order]
Optional

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

Params

Param Name Description
organization_id
Required

identifiant de l'organisation

Validations:

  • number.

name
Required

nom

Validations:

  • String

description
Optional

description

Validations:

  • String

environment
Optional

environnement

Validations:

  • Hash

environment_id
Optional

id de l'environnement

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_id
Optional

ID de l'affichage de contenu

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

max_hosts
Optional

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

Validations:

  • number.

unlimited_hosts
Optional

can the activation key have unlimited hosts

Validations:

  • boolean


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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

organization_id
Required

identifiant de l'organisation

Validations:

  • number.

name
Optional

nom

Validations:

  • String

description
Optional

description

Validations:

  • String

environment_id
Optional

id de l'environnement

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_id
Optional

ID de l'affichage de contenu

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

max_hosts
Optional

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

Validations:

  • number.

unlimited_hosts
Optional

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
Optional

version du contenu

Validations:

  • String

service_level
Optional

niveau de service

Validations:

  • String

auto_attach
Optional

joindre automatiquement les abonnements lors de l'enregistrement

Validations:

  • boolean


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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

organization_id
Optional

identifiant de l'organisation

Validations:

  • number.


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

Params

Param Name Description
new_name
Required

Nom de la nouvelle clé d'activation

Validations:

  • String

id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

organization_id
Optional

identifiant de l'organisation

Validations:

  • number.


GET /katello/api/activation_keys/:id/host_collections/available
Répertorier les collections d'hôtes auxquelles le système n'appartient pas

Params

Param Name Description
search
Optional

Rechercher une chaîne

Validations:

  • String

page
Optional

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

Validations:

  • number.

per_page
Optional

Nombre de résultats par page à renvoyer

Validations:

  • number.

order
Optional

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

Validations:

  • String

full_results
Optional

Afficher tous les résultats ou pas

Validations:

  • boolean

sort
Optional

Version Hash des paramètres d'« ordre »

Validations:

  • Hash

sort[by]
Optional

Champs dans lequel trier les résultats

Validations:

  • String

sort[order]
Optional

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

Validations:

  • String

name
Optional

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

Params

Param Name Description
id
Required

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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • String


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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_collection_ids
Required

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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_collection_ids
Required

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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

subscription_id
Optional

Identifiant d'abonnement

Validations:

  • number.

quantity
Optional

Nombre de ces abonnements à ajouter.

Validations:

  • number.

subscriptions
Optional

Ensemble d'abonnements à ajouter

Validations:

  • Must be an Array of nested elements

subscriptions[id]
Optional

Uuid de pool d'abonnement

Validations:

  • String

subscriptions[quantity]
Optional

Quantité de cet abonnement à ajouter

Validations:

  • number.


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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

subscription_id
Optional

ID d'abonnement

Validations:

  • String

subscriptions
Optional

Ensemble d'abonnements à ajouter

Validations:

  • Must be an Array of nested elements

subscriptions[id]
Optional

Uuid de pool d'abonnement

Validations:

  • String


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

Params

Param Name Description
id
Required

ID d'une clé d'activation

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_override
Optional

Paramètres de remplacement de contenu

Validations:

  • Hash

content_override[content_label]
Required

Étiquette du contenu

Validations:

  • String

content_override[value]
Required

Rermplacer par 0/1 ou 'default'

Validations:

  • Must be one of: 0, 1, default.