GET /katello/api/repositories
已启用库列表

GET /katello/api/content_views/:id/repositories
内容视图的库列表

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

参数

参数名字 描述
organization_id
选填

显示所包含的库的机构 ID

Validations:

  • number.

product_id
选填

显示所包含库的产品 ID

Validations:

  • number.

environment_id
选填

显示所包含库的环境 ID

Validations:

  • number.

content_view_id
选填

显示库所在内容视图的 ID

Validations:

  • number.

content_view_version_id
选填

显示所包含库的内容视图版本 ID

Validations:

  • number.

deb_id
选填

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

Validations:

  • String

erratum_id
选填

Id of an erratum to find repositories that contain the erratum

Validations:

  • String

rpm_id
选填

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

Validations:

  • String

ostree_branch_id
选填

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

Validations:

  • String

library
选填

在 Library 及默认内容视图中显示库

Validations:

  • boolean

content_type
选填

limit to only repositories of this type

Validations:

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

name
选填

库名称

Validations:

  • String

available_for
选填

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

Validations:

  • String

search
选填

搜索字符串

Validations:

  • String

page
选填

页号,从 1 开始

Validations:

  • number.

per_page
选填

每页中显示的返回结果数

Validations:

  • number.

order
选填

排序字段及顺序,例如:'name DESC'

Validations:

  • String

full_result
选填

无论如何显示所有结果

Validations:

  • boolean

sort
选填

'order' 参数的哈希版本

Validations:

  • Hash

sort[by]
选填

结果排序字段

Validations:

  • String

sort[order]
选填

如何对分类结果进行排序(例如:ASC 代表升序)

Validations:

  • String


POST /katello/api/repositories
创建定制库

参数

参数名字 描述
name
必填

Validations:

  • String

label
选填

Validations:

  • String

product_id
必填

所生成库属于

Validations:

  • number.

content_type
必填

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

Validations:

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

url
选填

库源 url

Validations:

  • String

gpg_key_id
选填

要为新库分配的 gpg 密钥 id

Validations:

  • number.

unprotected
选填

如果可通过 HTTP 发布则为 true

Validations:

  • boolean

checksum_type
选填

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

Validations:

  • String

docker_upstream_name
选填

upstream docker 库名称

Validations:

  • String

download_policy
选填

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

Validations:

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

mirror_on_sync
选填

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

Validations:

  • boolean

verify_ssl_on_sync
选填

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

Validations:

  • boolean

upstream_username
选填

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
选填

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
选填

policies for syncing upstream ostree repositories.

Validations:

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

ostree_upstream_sync_depth
选填

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

Validations:

  • number.

deb_releases
选填

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

Validations:

  • String

deb_components
选填

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

Validations:

  • String

deb_architectures
选填

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

Validations:

  • String

ignore_global_proxy
选填

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

Validations:

  • boolean


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

参数

参数名字 描述
creatable
选填

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

Validations:

  • boolean


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

参数

参数名字 描述
id
必填

Repository identifier

Validations:

  • number.


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

参数

参数名字 描述
id
必填

库 ID

Validations:

  • number.


POST /katello/api/repositories/:id/sync
同步库

参数

参数名字 描述
id
必填

库 ID

Validations:

  • number.

source_url
选填

temporarily override feed URL for sync

Validations:

  • String

incremental
选填

perform an incremental import

Validations:

  • boolean

skip_metadata_check
选填

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

Validations:

  • boolean

validate_contents
选填

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

Validations:

  • boolean


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

参数

参数名字 描述
id
必填

Repository identifier

Validations:

  • number.

export_to_iso
选填

Export to ISO format

Validations:

  • boolean

iso_mb_size
选填

maximum size of each ISO in MB

Validations:

  • number.

since
选填

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

Validations:

  • Date


PUT /katello/api/repositories/:id
更新库

参数

参数名字 描述
id
必填

库 ID

Validations:

  • number.

name
选填

Validations:

  • String

url
选填

库源 url

Validations:

  • String

gpg_key_id
选填

要为新库分配的 gpg 密钥 id

Validations:

  • number.

unprotected
选填

如果可通过 HTTP 发布则为 true

Validations:

  • boolean

checksum_type
选填

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

Validations:

  • String

docker_upstream_name
选填

upstream docker 库名称

Validations:

  • String

download_policy
选填

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

Validations:

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

mirror_on_sync
选填

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

Validations:

  • boolean

verify_ssl_on_sync
选填

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

Validations:

  • boolean

upstream_username
选填

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
选填

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
选填

policies for syncing upstream ostree repositories.

Validations:

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

ostree_upstream_sync_depth
选填

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

Validations:

  • number.

deb_releases
选填

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

Validations:

  • String

deb_components
选填

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

Validations:

  • String

deb_architectures
选填

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

Validations:

  • String

ignore_global_proxy
选填

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

Validations:

  • boolean


DELETE /katello/api/repositories/:id
消除定制库

参数

参数名字 描述
id
必填

Validations:

  • number.


POST /katello/api/repositories/sync_complete

URL for post sync notification from pulp

参数

参数名字 描述
token
必填

共享的秘密 token

Validations:

  • String

payload
必填

Validations:

  • Hash

payload[repo_id]
必填

Validations:

  • String

call_report
必填

Validations:

  • Hash

call_report[task_id]
必填

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

参数

参数名字 描述
id
必填

库 ID

Validations:

  • number.

ids
必填

Array of content ids to remove

Validations:

  • Must be an array of any type

sync_capsule
选填

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

Validations:

  • boolean


POST /katello/api/repositories/:id/upload_content
将内容上传到库中

参数

参数名字 描述
id
必填

库 ID

Validations:

  • number.

content
必填

要上传的内容文件。可以是单一文件,也可以是文件数组。

Validations:

  • File


PUT /katello/api/repositories/:id/import_uploads
将上传导入库

参数

参数名字 描述
id
必填

库 id

Validations:

  • number.

upload_ids
选填

要导入的上传 id 阵列

Validations:

  • Must be an array of any type

async
选填

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

Validations:

  • boolean

publish_repository
选填

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

Validations:

  • boolean

sync_capsule
选填

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

Validations:

  • boolean

uploads
选填

Array of uploads to import

Validations:

  • Must be an Array of nested elements

uploads[id]
必填

Validations:

  • String

uploads[size]
选填

Validations:

  • String

uploads[checksum]
选填

Validations:

  • String

uploads[name]
选填

Needs to only be set for file repositories

Validations:

  • String


GET /katello/api/repositories/:id/gpg_key_content
返回由 yum 直接使用的库 gpg 密钥内容

参数

参数名字 描述
id
必填

Validations:

  • number.