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:

  • Must be a number.

product_id
選填

欲顯示其軟體庫的產品之 ID

Validations:

  • Must be a number.

environment_id
選填

欲顯示其軟體庫的環境之 ID

Validations:

  • Must be a number.

content_view_id
選填

欲顯示其內部軟體庫的內容視域之 ID

Validations:

  • Must be a number.

content_view_version_id
選填

欲顯示其內部軟體庫的內容視域版本之 ID

Validations:

  • Must be a 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

file_id
選填

Id of a file to find repositories that contain the file

Validations:

  • String

ostree_branch_id
選填

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

Validations:

  • String

library
選填

在函示庫與預設內容視域中顯示軟體庫

Validations:

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

content_type
選填

limit to only repositories of this type

Validations:

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

name
選填

軟體庫名稱

Validations:

  • String

description
選填

description of the repository

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:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

order
選填

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
選填

是否顯示所有結果

Validations:

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

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:

  • Must be a 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
選填

軟體庫來源的網址

Validations:

  • String

gpg_key_id
選填

要指定給新軟體庫的GPG 金鑰之 ID

Validations:

  • Must be a number.

ssl_ca_cert_id
選填

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.

ssl_client_cert_id
選填

Identifier of the SSL Client Cert

Validations:

  • Must be a number.

ssl_client_key_id
選填

Identifier of the SSL Client Key

Validations:

  • Must be a number.

unprotected
選填

如果此軟體庫可以透過 HTTP 出版,設為真

Validations:

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

checksum_type
選填

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

Validations:

  • String

docker_upstream_name
選填

上游 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:

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

verify_ssl_on_sync
選填

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
選填

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:

  • Must be a 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:

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

ignorable_content
選填

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

參數

參數名字 描述
creatable
選填

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.

參數

參數名字 描述
id
必填

Repository identifier

Validations:

  • Must be a number.


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

參數

參數名字 描述
id
必填

軟體庫 ID

Validations:

  • Must be a number.


POST /katello/api/repositories/:id/sync
同步軟體庫

參數

參數名字 描述
id
必填

軟體庫 ID

Validations:

  • Must be a number.

source_url
選填

temporarily override feed URL for sync

Validations:

  • String

incremental
選填

perform an incremental import

Validations:

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

skip_metadata_check
選填

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
選填

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

參數

參數名字 描述
id
必填

Repository identifier

Validations:

  • Must be a number.

export_to_iso
選填

Export to ISO format

Validations:

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

iso_mb_size
選填

maximum size of each ISO in MB

Validations:

  • Must be a number.

since
選填

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

Validations:

  • Date


PUT /katello/api/repositories/:id
更新軟體庫

參數

參數名字 描述
id
必填

軟體庫 ID

Validations:

  • Must be a number.

name
選填

Validations:

  • String

url
選填

軟體庫來源的網址

Validations:

  • String

gpg_key_id
選填

要指定給新軟體庫的GPG 金鑰之 ID

Validations:

  • Must be a number.

ssl_ca_cert_id
選填

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.

ssl_client_cert_id
選填

Identifier of the SSL Client Cert

Validations:

  • Must be a number.

ssl_client_key_id
選填

Identifier of the SSL Client Key

Validations:

  • Must be a number.

unprotected
選填

如果此軟體庫可以透過 HTTP 出版,設為真

Validations:

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

checksum_type
選填

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

Validations:

  • String

docker_upstream_name
選填

上游 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:

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

verify_ssl_on_sync
選填

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
選填

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:

  • Must be a 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:

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

ignorable_content
選填

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
銷毀自訂軟體庫

參數

參數名字 描述
id
必填

Validations:

  • Must be a 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:

  • Must be a 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:

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


POST /katello/api/repositories/:id/upload_content
上傳內容至軟體庫

參數

參數名字 描述
id
必填

軟體庫 ID

Validations:

  • Must be a number.

content
必填

欲上傳的內容檔案。能夠是單一檔案或檔案集。

Validations:

  • File


PUT /katello/api/repositories/:id/import_uploads
將上傳內容匯入軟體庫中

參數

參數名字 描述
id
必填

軟體庫 ID

Validations:

  • Must be a 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:

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

publish_repository
選填

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

Validations:

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

sync_capsule
選填

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

Validations:

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

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 or docker tags

Validations:

  • String

uploads[digest]
選填

Needs to only be set for docker tags

Validations:

  • String


GET /katello/api/repositories/:id/gpg_key_content
回傳軟體庫 GPG 金鑰的內容,直接由 yum 所使用

參數

參數名字 描述
id
必填

Validations:

  • Must be a number.