GET /katello/api/activation_keys
Aktivierungsschlüssel auflisten

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

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

Parameter

Parametername Beschreibung
organization_id
verpflichtend

Organisations-ID

Validations:

  • number.

environment_id
optional

Umgebungs-ID

Validations:

  • number.

content_view_id
optional

Inhaltsansichts-ID

Validations:

  • number.

name
optional

Name des Aktivierungsschlüssels, nach dem gefiltert werden soll

Validations:

  • String

search
optional

Suchbegriff

Validations:

  • String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • number.

order
optional

Sortierungsfeld und Reihenfolge, z. B. “name DESC”

Validations:

  • String

full_result
optional

Ob alle Ergebnisse angezeigt werden sollen

Validations:

  • boolean

sort
optional

Hash-Version des “order”-Parameters

Validations:

  • Hash

sort[by]
optional

Ergebnisse nach diesem Feld sortieren

Validations:

  • String

sort[order]
optional

Reihenfolge der sortierten Ergebnisse (z. B. ASC für aufsteigend)

Validations:

  • String


POST /katello/api/activation_keys
Aktivierungsschlüssel erstellen

Parameter

Parametername Beschreibung
organization_id
verpflichtend

Organisations-ID

Validations:

  • number.

name
verpflichtend

Name

Validations:

  • String

description
optional

Beschreibung

Validations:

  • String

environment
optional

Umgebung

Validations:

  • Hash

environment_id
optional

Umgebungskennung

Validations:

  • number.

content_view_id
optional

Inhaltsansichts-ID

Validations:

  • number.

max_hosts
optional

Höchstanzahl von registrierten Inhaltshosts

Validations:

  • number.

unlimited_hosts
optional

can the activation key have unlimited hosts

Validations:

  • boolean


PUT /katello/api/activation_keys/:id
Aktivierungsschlüssel aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

organization_id
verpflichtend

Organisations-ID

Validations:

  • number.

name
optional

Name

Validations:

  • String

description
optional

Beschreibung

Validations:

  • String

environment_id
optional

Umgebungskennung

Validations:

  • number.

content_view_id
optional

Inhaltsansichts-ID

Validations:

  • number.

max_hosts
optional

Höchstanzahl von registrierten Inhaltshosts

Validations:

  • number.

unlimited_hosts
optional

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
optional

Inhalts-Release-Version

Validations:

  • String

service_level
optional

Servicelevel

Validations:

  • String

auto_attach
optional

Nach Registrierung automatisch mit Subskriptionen verknüpfen

Validations:

  • boolean


DELETE /katello/api/activation_keys/:id
Aktivierungsschlüssel löschen

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.


GET /katello/api/activation_keys/:id
Aktivierungsschlüssel anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

organization_id
optional

Organisations-ID

Validations:

  • number.


POST /katello/api/activation_keys/:id/copy
Aktivierungsschlüssel kopieren

Parameter

Parametername Beschreibung
new_name
verpflichtend

Name des neuen Aktivierungsschlüssels

Validations:

  • String

id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

organization_id
optional

Organisations-ID

Validations:

  • number.


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

Parameter

Parametername Beschreibung
search
optional

Suchbegriff

Validations:

  • String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • number.

order
optional

Sortierungsfeld und Reihenfolge, z. B. “name DESC”

Validations:

  • String

full_result
optional

Ob alle Ergebnisse angezeigt werden sollen

Validations:

  • boolean

sort
optional

Hash-Version des “order”-Parameters

Validations:

  • Hash

sort[by]
optional

Ergebnisse nach diesem Feld sortieren

Validations:

  • String

sort[order]
optional

Reihenfolge der sortierten Ergebnisse (z. B. ASC für aufsteigend)

Validations:

  • String

name
optional

Name der Hostsammlung, nach der gefiltert werden soll

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
Verfügbare Release-Versionen für einen Aktivierungsschlüssel anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
Verfügbare Inhalte für einen Aktivierungsschlüssel anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • String

content_access_mode_all
optional

Get all content available, not just that provided by subscriptions

Validations:

  • boolean

content_access_mode_env
optional

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

Validations:

  • boolean


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

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

host_collection_ids
verpflichtend

Liste mit Hostsammlungs-IDs, wie dem Aktivierungsschlüssel zugewiesen werden sollen

Validations:

  • Must be an array of any type


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

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

host_collection_ids
verpflichtend

Liste mit Hostsammlungs-IDs, die vom Aktivierungsschlüssel gelöst werden sollen

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
Subskription verknüpfen

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

subscription_id
optional

Subskriptions-ID

Validations:

  • number.

quantity
optional

Hinzuzufügende Anzahl dieser Subskription

Validations:

  • number.

subscriptions
optional

Array der hinzuzufügenden Subskriptionen

Validations:

  • Must be an Array of nested elements

subscriptions[id]
optional

Subskriptionspool-UUID

Validations:

  • String

subscriptions[quantity]
optional

Hinzuzufügende Anzahl der Subskription

Validations:

  • number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
Subskription lösen

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

subscription_id
optional

Subskriptions-ID

Validations:

  • String

subscriptions
optional

Array der hinzuzufügenden Subskriptionen

Validations:

  • Must be an Array of nested elements

subscriptions[id]
optional

Subskriptionspool-UUID

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
Inhalt überschreiben für activation_key

Parameter

Parametername Beschreibung
id
verpflichtend

ID des Aktivierungsschlüssels

Validations:

  • number.

content_override
optional

Inhaltsüberschreibungs-Parameter

Validations:

  • Hash

content_override[content_label]
verpflichtend

Kennung des Inhalts

Validations:

  • String

content_override[value]
verpflichtend

Override to a boolean value or 'default'

Validations:

  • String

content_overrides
optional

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
verpflichtend

Kennung des Inhalts

Validations:

  • String

content_overrides[value]
optional

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

Validations:

  • String

content_overrides[name]
optional

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

Validations:

  • String

content_overrides[remove]
optional

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

Validations:

  • boolean