GET /katello/api/repositories
Liste de référentiels activés

GET /katello/api/content_views/:id/repositories
Liste de référentiels pour un affichage de contenu

GET /katello/api/organizations/:organization_id/repositories
List of repositories in an organization

GET /katello/api/organizations/:organization_id/environments/:environment_id/repositories
List repositories in the environment

GET /katello/api/products/:product_id/repositories
List of repositories for a product

GET /katello/api/environments/:environment_id/products/:product_id/repositories
List of repositories belonging to a product in an environment

Paramètres

Nom du paramètre Description
organization_id
optionel

ID d'une organisation dans laquelle afficher les référentiels

Validations:

  • Must be a number.

product_id
optionel

ID d'un produit pour lequel afficher les référentiels

Validations:

  • Must be a number.

environment_id
optionel

ID d'un environnement dans lequel afficher les référentiels

Validations:

  • Must be a number.

content_view_id
optionel

ID d'un affichage de contenu dans lequel afficher les référentiels

Validations:

  • Must be a number.

content_view_version_id
optionel

ID d'une version d'affichage de contenu sur laquelle afficher les référentiels

Validations:

  • Must be a number.

deb_id
optionel

Id of a deb package to find repositories that contain the deb

Validations:

  • String

erratum_id
optionel

Id of an erratum to find repositories that contain the erratum

Validations:

  • String

rpm_id
optionel

Id of a rpm package to find repositories that contain the rpm

Validations:

  • String

file_id
optionel

Id of a file to find repositories that contain the file

Validations:

  • String

ostree_branch_id
optionel

Id of an ostree branch to find repositories that contain that branch

Validations:

  • String

library
optionel

afficher les référentiels dans la Bibliothèque et l'affichage de contenu par défaut

Validations:

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

content_type
optionel

limit to only repositories of this type

Validations:

  • Must be one of: docker, ostree, yum, puppet, file, deb.

name
optionel

nom du référentiel

Validations:

  • String

description
optionel

description of the repository

Validations:

  • String

available_for
optionel

interpret specified object to return only Repositories that can be associated with specified object. Only 'content_view' is supported.

Validations:

  • String

search
optionel

Rechercher une chaîne

Validations:

  • String

page
optionel

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

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

order
optionel

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optionel

Afficher tous les résultats ou pas

Validations:

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

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/repositories
Créer un référentiel personnalisé

Paramètres

Nom du paramètre Description
name
requis

Validations:

  • String

label
optionel

Validations:

  • String

product_id
requis

Produit auquel le référentiel appartient

Validations:

  • Must be a number.

content_type
requis

type of repo (either 'yum', 'deb', 'puppet', 'docker', or 'ostree')

Validations:

  • Must be one of: docker, ostree, yum, puppet, file, deb.

url
optionel

URL de la source du référentiel

Validations:

  • String

gpg_key_id
optionel

id de la clé gpg qui sera assignée au nouveau référentiel

Validations:

  • Must be a number.

ssl_ca_cert_id
optionel

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.

ssl_client_cert_id
optionel

Identifier of the SSL Client Cert

Validations:

  • Must be a number.

ssl_client_key_id
optionel

Identifier of the SSL Client Key

Validations:

  • Must be a number.

unprotected
optionel

vrai si ce référentiel peut être publié via HTTP

Validations:

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

checksum_type
optionel

checksum of the repository, currently 'sha1' & 'sha256' are supported.

Validations:

  • String

docker_upstream_name
optionel

nom du référentiel docker en amont

Validations:

  • String

download_policy
optionel

download policy for yum repos (either 'immediate', 'on_demand', or 'background')

Validations:

  • Must be one of: immediate, on_demand, background.

mirror_on_sync
optionel

true if this repository when synced has to be mirrored from the source and stale rpms removed.

Validations:

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

verify_ssl_on_sync
optionel

if true, Katello will verify the upstream url's SSL certifcates are signed by a trusted CA.

Validations:

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

upstream_username
optionel

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
optionel

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
optionel

policies for syncing upstream ostree repositories.

Validations:

  • Must be one of: latest, all, custom.

ostree_upstream_sync_depth
optionel

if a custom sync policy is chosen for ostree repositories then a 'depth' value must be provided.

Validations:

  • Must be a number.

deb_releases
optionel

comma separated list of releases to be synched from deb-archive

Validations:

  • String

deb_components
optionel

comma separated list of repo components to be synched from deb-archive

Validations:

  • String

deb_architectures
optionel

comma separated list of architectures to be synched from deb-archive

Validations:

  • String

ignore_global_proxy
optionel

if true, will ignore the globally configured proxy when syncing.

Validations:

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

ignorable_content
optionel

List of content units to ignore while syncing a yum repository. Must be subset of rpm,drpm,srpm,distribution,erratum

Validations:

  • Must be an array of any type


GET /katello/api/repositories/repository_types
Show the available repository types

Paramètres

Nom du paramètre Description
creatable
optionel

When set to 'True' repository types that are creatable will be returned

Validations:

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


PUT /katello/api/repositories/:id/republish
Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.

Paramètres

Nom du paramètre Description
id
requis

Repository identifier

Validations:

  • Must be a number.


GET /katello/api/repositories/:id
Show a repository

Paramètres

Nom du paramètre Description
id
requis

ID du référentiel

Validations:

  • Must be a number.


POST /katello/api/repositories/:id/sync
Synchroniser un référentiel

Paramètres

Nom du paramètre Description
id
requis

ID du référentiel

Validations:

  • Must be a number.

source_url
optionel

temporarily override feed URL for sync

Validations:

  • String

incremental
optionel

perform an incremental import

Validations:

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

skip_metadata_check
optionel

Force sync even if no upstream changes are detected. Only used with yum repositories.

Validations:

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

validate_contents
optionel

Force a sync and validate the checksums of all content. Only used with yum repositories.

Validations:

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


POST /katello/api/repositories/:id/export
Export a repository

Paramètres

Nom du paramètre Description
id
requis

Repository identifier

Validations:

  • Must be a number.

export_to_iso
optionel

Export to ISO format

Validations:

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

iso_mb_size
optionel

maximum size of each ISO in MB

Validations:

  • Must be a number.

since
optionel

Optional date of last export (ex: 2010-01-01T12:00:00Z)

Validations:

  • Date


PUT /katello/api/repositories/:id
Mettre à jour un référentiel

Paramètres

Nom du paramètre Description
id
requis

ID du référentiel

Validations:

  • Must be a number.

name
optionel

Validations:

  • String

url
optionel

URL de la source du référentiel

Validations:

  • String

gpg_key_id
optionel

id de la clé gpg qui sera assignée au nouveau référentiel

Validations:

  • Must be a number.

ssl_ca_cert_id
optionel

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.

ssl_client_cert_id
optionel

Identifier of the SSL Client Cert

Validations:

  • Must be a number.

ssl_client_key_id
optionel

Identifier of the SSL Client Key

Validations:

  • Must be a number.

unprotected
optionel

vrai si ce référentiel peut être publié via HTTP

Validations:

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

checksum_type
optionel

checksum of the repository, currently 'sha1' & 'sha256' are supported.

Validations:

  • String

docker_upstream_name
optionel

nom du référentiel docker en amont

Validations:

  • String

download_policy
optionel

download policy for yum repos (either 'immediate', 'on_demand', or 'background')

Validations:

  • Must be one of: immediate, on_demand, background.

mirror_on_sync
optionel

true if this repository when synced has to be mirrored from the source and stale rpms removed.

Validations:

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

verify_ssl_on_sync
optionel

if true, Katello will verify the upstream url's SSL certifcates are signed by a trusted CA.

Validations:

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

upstream_username
optionel

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
optionel

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
optionel

policies for syncing upstream ostree repositories.

Validations:

  • Must be one of: latest, all, custom.

ostree_upstream_sync_depth
optionel

if a custom sync policy is chosen for ostree repositories then a 'depth' value must be provided.

Validations:

  • Must be a number.

deb_releases
optionel

comma separated list of releases to be synched from deb-archive

Validations:

  • String

deb_components
optionel

comma separated list of repo components to be synched from deb-archive

Validations:

  • String

deb_architectures
optionel

comma separated list of architectures to be synched from deb-archive

Validations:

  • String

ignore_global_proxy
optionel

if true, will ignore the globally configured proxy when syncing.

Validations:

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

ignorable_content
optionel

List of content units to ignore while syncing a yum repository. Must be subset of rpm,drpm,srpm,distribution,erratum

Validations:

  • Must be an array of any type


DELETE /katello/api/repositories/:id
Détruire un référentiel personnalisé

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a number.


POST /katello/api/repositories/sync_complete

URL for post sync notification from pulp

Paramètres

Nom du paramètre Description
token
requis

jeton secret partagé

Validations:

  • String

payload
requis

Validations:

  • Hash

payload[repo_id]
requis

Validations:

  • String

call_report
requis

Validations:

  • Hash

call_report[task_id]
requis

Validations:

  • String


PUT /katello/api/repositories/:id/remove_packages

PUT /katello/api/repositories/:id/remove_docker_manifests

PUT /katello/api/repositories/:id/remove_puppet_modules

PUT /katello/api/repositories/:id/remove_content

Remove content from a repository

Paramètres

Nom du paramètre Description
id
requis

ID du référentiel

Validations:

  • Must be a number.

ids
requis

Array of content ids to remove

Validations:

  • Must be an array of any type

sync_capsule
optionel

Whether or not to sync an external capsule after upload. Default: true

Validations:

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


POST /katello/api/repositories/:id/upload_content
Télécharger le contenu dans le référentiel

Paramètres

Nom du paramètre Description
id
requis

ID du référentiel

Validations:

  • Must be a number.

content
requis

Fichiers de contenu à télécharger. Il peut s'agir d'un fichier unique ou d'un ensemble de fichiers.

Validations:

  • File


PUT /katello/api/repositories/:id/import_uploads
Importer les téléchargements dans un référentiel

Paramètres

Nom du paramètre Description
id
requis

Id de référentiel

Validations:

  • Must be a number.

upload_ids
optionel

Ensemble d'id de téléchargement à importer

Validations:

  • Must be an array of any type

async
optionel

Do not wait for the ImportUpload action to finish. Default: false

Validations:

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

publish_repository
optionel

Whether or not to regenerate the repository on disk. Default: true

Validations:

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

sync_capsule
optionel

Whether or not to sync an external capsule after upload. Default: true

Validations:

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

uploads
optionel

Array of uploads to import

Validations:

  • Must be an Array of nested elements

uploads[id]
requis

Validations:

  • String

uploads[size]
optionel

Validations:

  • String

uploads[checksum]
optionel

Validations:

  • String

uploads[name]
optionel

Needs to only be set for file repositories or docker tags

Validations:

  • String

uploads[digest]
optionel

Needs to only be set for docker tags

Validations:

  • String


GET /katello/api/repositories/:id/gpg_key_content
Renvoyer le contenu d'une clé gpg de référentiel, utilisé directement par yum

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a number.