GET /katello/api/repositories
List of enabled repositories

GET /katello/api/content_views/:id/repositories
List of repositories for a content view

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

Parametry

Nazwa parametru Opis
organization_id
opcjonalny

ID of an organization to show repositories in

Validations:

  • Must be a number.

product_id
opcjonalny

ID of a product to show repositories of

Validations:

  • Must be a number.

environment_id
opcjonalny

ID of an environment to show repositories in

Validations:

  • Must be a number.

content_view_id
opcjonalny

ID of a content view to show repositories in

Validations:

  • Must be a number.

content_view_version_id
opcjonalny

ID of a content view version to show repositories in

Validations:

  • Must be a number.

deb_id
opcjonalny

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

Validations:

  • String

erratum_id
opcjonalny

Id of an erratum to find repositories that contain the erratum

Validations:

  • String

rpm_id
opcjonalny

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

Validations:

  • String

file_id
opcjonalny

Id of a file to find repositories that contain the file

Validations:

  • String

ostree_branch_id
opcjonalny

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

Validations:

  • String

library
opcjonalny

show repositories in Library and the default content view

Validations:

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

content_type
opcjonalny

limit to only repositories of this type

Validations:

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

name
opcjonalny

name of the repository

Validations:

  • String

description
opcjonalny

description of the repository

Validations:

  • String

available_for
opcjonalny

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

Validations:

  • String

search
opcjonalny

Search string

Validations:

  • String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

order
opcjonalny

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
opcjonalny

Whether or not to show all results

Validations:

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

sort
opcjonalny

Hash version of 'order' param

Validations:

  • Hash

sort[by]
opcjonalny

Field to sort the results on

Validations:

  • String

sort[order]
opcjonalny

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String


POST /katello/api/repositories
Create a custom repository

Parametry

Nazwa parametru Opis
name
wymagany

Validations:

  • String

label
opcjonalny

Validations:

  • String

product_id
wymagany

Product the repository belongs to

Validations:

  • Must be a number.

content_type
wymagany

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

Validations:

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

url
opcjonalny

repository source url

Validations:

  • String

gpg_key_id
opcjonalny

id of the gpg key that will be assigned to the new repository

Validations:

  • Must be a number.

ssl_ca_cert_id
opcjonalny

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.

ssl_client_cert_id
opcjonalny

Identifier of the SSL Client Cert

Validations:

  • Must be a number.

ssl_client_key_id
opcjonalny

Identifier of the SSL Client Key

Validations:

  • Must be a number.

unprotected
opcjonalny

true if this repository can be published via HTTP

Validations:

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

checksum_type
opcjonalny

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

Validations:

  • String

docker_upstream_name
opcjonalny

name of the upstream docker repository

Validations:

  • String

download_policy
opcjonalny

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

Validations:

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

mirror_on_sync
opcjonalny

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
opcjonalny

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
opcjonalny

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
opcjonalny

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
opcjonalny

policies for syncing upstream ostree repositories.

Validations:

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

ostree_upstream_sync_depth
opcjonalny

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

Validations:

  • Must be a number.

deb_releases
opcjonalny

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

Validations:

  • String

deb_components
opcjonalny

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

Validations:

  • String

deb_architectures
opcjonalny

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

Validations:

  • String

ignore_global_proxy
opcjonalny

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

Validations:

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

ignorable_content
opcjonalny

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

Parametry

Nazwa parametru Opis
creatable
opcjonalny

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.

Parametry

Nazwa parametru Opis
id
wymagany

Repository identifier

Validations:

  • Must be a number.


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

Parametry

Nazwa parametru Opis
id
wymagany

repository ID

Validations:

  • Must be a number.


POST /katello/api/repositories/:id/sync
Sync a repository

Parametry

Nazwa parametru Opis
id
wymagany

repository ID

Validations:

  • Must be a number.

source_url
opcjonalny

temporarily override feed URL for sync

Validations:

  • String

incremental
opcjonalny

perform an incremental import

Validations:

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

skip_metadata_check
opcjonalny

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
opcjonalny

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

Parametry

Nazwa parametru Opis
id
wymagany

Repository identifier

Validations:

  • Must be a number.

export_to_iso
opcjonalny

Export to ISO format

Validations:

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

iso_mb_size
opcjonalny

maximum size of each ISO in MB

Validations:

  • Must be a number.

since
opcjonalny

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

Validations:

  • Date


PUT /katello/api/repositories/:id
Update a repository

Parametry

Nazwa parametru Opis
id
wymagany

repository ID

Validations:

  • Must be a number.

name
opcjonalny

Validations:

  • String

url
opcjonalny

repository source url

Validations:

  • String

gpg_key_id
opcjonalny

id of the gpg key that will be assigned to the new repository

Validations:

  • Must be a number.

ssl_ca_cert_id
opcjonalny

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.

ssl_client_cert_id
opcjonalny

Identifier of the SSL Client Cert

Validations:

  • Must be a number.

ssl_client_key_id
opcjonalny

Identifier of the SSL Client Key

Validations:

  • Must be a number.

unprotected
opcjonalny

true if this repository can be published via HTTP

Validations:

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

checksum_type
opcjonalny

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

Validations:

  • String

docker_upstream_name
opcjonalny

name of the upstream docker repository

Validations:

  • String

download_policy
opcjonalny

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

Validations:

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

mirror_on_sync
opcjonalny

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
opcjonalny

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
opcjonalny

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
opcjonalny

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
opcjonalny

policies for syncing upstream ostree repositories.

Validations:

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

ostree_upstream_sync_depth
opcjonalny

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

Validations:

  • Must be a number.

deb_releases
opcjonalny

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

Validations:

  • String

deb_components
opcjonalny

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

Validations:

  • String

deb_architectures
opcjonalny

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

Validations:

  • String

ignore_global_proxy
opcjonalny

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

Validations:

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

ignorable_content
opcjonalny

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
Destroy a custom repository

Parametry

Nazwa parametru Opis
id
wymagany

Validations:

  • Must be a number.


POST /katello/api/repositories/sync_complete

URL for post sync notification from pulp

Parametry

Nazwa parametru Opis
token
wymagany

shared secret token

Validations:

  • String

payload
wymagany

Validations:

  • Hash

payload[repo_id]
wymagany

Validations:

  • String

call_report
wymagany

Validations:

  • Hash

call_report[task_id]
wymagany

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

Parametry

Nazwa parametru Opis
id
wymagany

repository ID

Validations:

  • Must be a number.

ids
wymagany

Array of content ids to remove

Validations:

  • Must be an array of any type

sync_capsule
opcjonalny

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
Upload content into the repository

Parametry

Nazwa parametru Opis
id
wymagany

repository ID

Validations:

  • Must be a number.

content
wymagany

Content files to upload. Can be a single file or array of files.

Validations:

  • File


PUT /katello/api/repositories/:id/import_uploads
Import uploads into a repository

Parametry

Nazwa parametru Opis
id
wymagany

Repository id

Validations:

  • Must be a number.

upload_ids
opcjonalny

Array of upload ids to import

Validations:

  • Must be an array of any type

async
opcjonalny

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

Validations:

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

publish_repository
opcjonalny

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

Validations:

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

sync_capsule
opcjonalny

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

Validations:

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

uploads
opcjonalny

Array of uploads to import

Validations:

  • Must be an Array of nested elements

uploads[id]
wymagany

Validations:

  • String

uploads[size]
opcjonalny

Validations:

  • String

uploads[checksum]
opcjonalny

Validations:

  • String

uploads[name]
opcjonalny

Needs to only be set for file repositories or docker tags

Validations:

  • String

uploads[digest]
opcjonalny

Needs to only be set for docker tags

Validations:

  • String


GET /katello/api/repositories/:id/gpg_key_content
Return the content of a repo gpg key, used directly by yum

Parametry

Nazwa parametru Opis
id
wymagany

Validations:

  • Must be a number.