GET /katello/api/activation_keys
Listar chaves de ativação

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

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

Parâmentros

Nome parâmetro Descrição
organization_id
requerido

identificador da organização

Validations:

  • number.

environment_id
opcional

identificador de ambiente

Validations:

  • number.

content_view_id
opcional

identificador de visualização de conteúdo

Validations:

  • number.

name
opcional

Realizar busca por nome da chave de ativação

Validations:

  • String

search
opcional

Buscar faixa

Validations:

  • String

page
opcional

Número de página, iniciando em 1

Validations:

  • number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • number.

order
opcional

Classificar campo e ordem, ex. 'name DESC'

Validations:

  • String

full_result
opcional

Se deve ou não exibir todos os resultados

Validations:

  • boolean

sort
opcional

Versão Hash de param de “ordem”

Validations:

  • Hash

sort[by]
opcional

Campo para classificar os resultados

Validations:

  • String

sort[order]
opcional

Como encomendar os resultados classificados (por exemplo ASC para ascendente)

Validations:

  • String


POST /katello/api/activation_keys
Criar uma chave de ativação

Parâmentros

Nome parâmetro Descrição
organization_id
requerido

identificador da organização

Validations:

  • number.

name
requerido

nome

Validations:

  • String

description
opcional

descrição

Validations:

  • String

environment
opcional

ambiente

Validations:

  • Hash

environment_id
opcional

id de ambiente

Validations:

  • number.

content_view_id
opcional

id de visualização de conteúdo

Validations:

  • number.

max_hosts
opcional

O número máximo de hosts de conteúdo registrados

Validations:

  • number.

unlimited_hosts
opcional

can the activation key have unlimited hosts

Validations:

  • boolean


PUT /katello/api/activation_keys/:id
Atualizar uma chave de ativação

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

organization_id
requerido

identificador da organização

Validations:

  • number.

name
opcional

nome

Validations:

  • String

description
opcional

descrição

Validations:

  • String

environment_id
opcional

id de ambiente

Validations:

  • number.

content_view_id
opcional

id de visualização de conteúdo

Validations:

  • number.

max_hosts
opcional

O número máximo de hosts de conteúdo registrados

Validations:

  • number.

unlimited_hosts
opcional

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
opcional

versão do lançamento de conteúdo

Validations:

  • String

service_level
opcional

nível de serviço

Validations:

  • String

auto_attach
opcional

auto conectar subscrições durante registro

Validations:

  • boolean


DELETE /katello/api/activation_keys/:id
Destruir uma chave de ativação

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.


GET /katello/api/activation_keys/:id
Exibir uma chave de ativação

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

organization_id
opcional

identificador da organização

Validations:

  • number.


POST /katello/api/activation_keys/:id/copy
Copiar uma chave de ativação

Parâmentros

Nome parâmetro Descrição
new_name
requerido

Nome da nova Chave de Ativação

Validations:

  • String

id
requerido

ID de chaves de ativação

Validations:

  • number.

organization_id
opcional

identificador da organização

Validations:

  • number.


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

Parâmentros

Nome parâmetro Descrição
search
opcional

Buscar faixa

Validations:

  • String

page
opcional

Número de página, iniciando em 1

Validations:

  • number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • number.

order
opcional

Classificar campo e ordem, ex. 'name DESC'

Validations:

  • String

full_result
opcional

Se deve ou não exibir todos os resultados

Validations:

  • boolean

sort
opcional

Versão Hash de param de “ordem”

Validations:

  • Hash

sort[by]
opcional

Campo para classificar os resultados

Validations:

  • String

sort[order]
opcional

Como encomendar os resultados classificados (por exemplo ASC para ascendente)

Validations:

  • String

name
opcional

filtrar por nome de coleção de host

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
Exibir versões de lançamento disponíveis para uma chanve de ativação

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
Exibir conteúdo disponível para uma chave de ativação

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • String

content_access_mode_all
opcional

Get all content available, not just that provided by subscriptions

Validations:

  • boolean

content_access_mode_env
opcional

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

Validations:

  • boolean


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

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

host_collection_ids
requerido

Lista de IDs de coleta de host para associar a chave de ativação

Validations:

  • Must be an array of any type


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

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

host_collection_ids
requerido

Lista de IDs de coleta de host para desassociar a chave de ativação

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
Anexar uma subscrição

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

subscription_id
opcional

Identificador de subscrição

Validations:

  • number.

quantity
opcional

Quantidade desta subscrição a adicionar.

Validations:

  • number.

subscriptions
opcional

Matriz de subscrições a adicionar

Validations:

  • Must be an Array of nested elements

subscriptions[id]
opcional

uuid de Pool de subscrição

Validations:

  • String

subscriptions[quantity]
opcional

Quantidade destas inscrições para adicionar

Validations:

  • number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
Desanexar uma subscrição

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

subscription_id
opcional

Id de subscrição

Validations:

  • String

subscriptions
opcional

Matriz de subscrições a adicionar

Validations:

  • Must be an Array of nested elements

subscriptions[id]
opcional

uuid de Pool de subscrição

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
Sobrescrever conteúdo para chave_ativação

Parâmentros

Nome parâmetro Descrição
id
requerido

ID de chaves de ativação

Validations:

  • number.

content_override
opcional

Parâmetros de sobrescrição de conteúdo

Validations:

  • Hash

content_override[content_label]
requerido

Rótulo do Conteúdo

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

Rótulo do Conteúdo

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:

  • boolean