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

Params

Param name Description
organization_id
optional

ID of an organization to show repositories in

Validations:

  • number.

product_id
optional

ID of a product to show repositories of

Validations:

  • number.

environment_id
optional

ID of an environment to show repositories in

Validations:

  • number.

content_view_id
optional

ID of a content view to show repositories in

Validations:

  • number.

content_view_version_id
optional

ID of a content view version to show repositories in

Validations:

  • number.

erratum_id
optional

Id of an erratum to find repositories that contain the erratum

Validations:

  • String

rpm_id
optional

Id of a package to find repositories that contain the rpm

Validations:

  • String

ostree_branch_id
optional

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

Validations:

  • String

library
optional

show repositories in Library and the default content view

Validations:

  • boolean

content_type
optional

limit to only repositories of this type

Validations:

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

name
optional

name of the repository

Validations:

  • String

available_for
optional

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

Validations:

  • String

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • number.

per_page
optional

Number of results per page to return

Validations:

  • number.

order
optional

Sort field and order, eg. ‘name DESC’

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • boolean

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

sort[by]
optional

Field to sort the results on

Validations:

  • String

sort[order]
optional

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

Validations:

  • String


POST /katello/api/repositories
Create a custom repository

Params

Param name Description
name
required

Validations:

  • String

label
optional

Validations:

  • String

product_id
required

Product the repository belongs to

Validations:

  • number.

url
optional

repository source url

Validations:

  • String

gpg_key_id
optional

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

Validations:

  • number.

unprotected
optional

true if this repository can be published via HTTP

Validations:

  • boolean

content_type
required

type of repo (either ‘yum’, ‘puppet’, ‘docker’, or ‘ostree’)

Validations:

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

checksum_type
optional

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

Validations:

  • String

docker_upstream_name
optional

name of the upstream docker repository

Validations:

  • String

download_policy
optional

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

Validations:

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

mirror_on_sync
optional

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

Validations:

  • boolean

verify_ssl_on_sync
optional

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

Validations:

  • boolean

upstream_username
optional

Username of the upstream repository user used for authentication

Validations:

  • String

upstream_password
optional

Password of the upstream repository user used for authentication

Validations:

  • String

ostree_upstream_sync_policy
optional

policies for syncing upstream ostree repositories.

Validations:

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

ostree_upstream_sync_depth
optional

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

Validations:

  • number.


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

Params

Param name Description
creatable
optional

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.

Params

Param name Description
id
required

Repository identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


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

Params

Param name Description
id
required

repository ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


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

Params

Param name Description
id
required

repository ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

source_url
optional

temporarily override feed URL for sync

Validations:

  • String

incremental
optional

perform an incremental import

Validations:

  • boolean

skip_metadata_check
optional

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

Validations:

  • boolean

validate_contents
optional

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

Params

Param name Description
id
required

Repository identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

export_to_iso
optional

Export to ISO format

Validations:

  • boolean

iso_mb_size
optional

maximum size of each ISO in MB

Validations:

  • number.

since
optional

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

Validations:

  • Date


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

Params

Param name Description
name
optional

New name for the repository

Validations:

  • String

id
required

repository ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

gpg_key_id
optional

ID of a gpg key that will be assigned to this repository

Validations:

  • number.

unprotected
optional

true if this repository can be published via HTTP

Validations:

  • boolean

checksum_type
optional

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

Validations:

  • String

url
optional

the feed url of the original repository

Validations:

  • String

docker_upstream_name
optional

name of the upstream docker repository

Validations:

  • String

download_policy
optional

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

Validations:

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

mirror_on_sync
optional

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

Validations:

  • boolean

verify_ssl_on_sync
optional

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

Validations:

  • boolean

upstream_username
optional

Username of the upstream repository user for authentication

Validations:

  • String

upstream_password
optional

Password of the upstream repository user for authentication

Validations:

  • String

ostree_upstream_sync_policy
optional

policies for syncing upstream ostree repositories.

Validations:

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

ostree_upstream_sync_depth
optional

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

Validations:

  • number.


DELETE /katello/api/repositories/:id
Destroy a custom repository

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /katello/api/repositories/sync_complete

URL for post sync notification from pulp

Params

Param name Description
token
required

shared secret token

Validations:

  • String

payload
required

Validations:

  • Hash

payload[repo_id]
required

Validations:

  • String

call_report
required

Validations:

  • Hash

call_report[task_id]
required

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

Params

Param name Description
id
required

repository ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

ids
required

Array of content ids to remove

Validations:

  • Must be an array of any type

sync_capsule
optional

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

Validations:

  • boolean


POST /katello/api/repositories/:id/upload_content
Upload content into the repository

Params

Param name Description
id
required

repository ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

content
required

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

Params

Param name Description
id
required

Repository id

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

upload_ids
optional

Array of upload ids to import

Validations:

  • Must be an array of any type

async
optional

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

Validations:

  • boolean

publish_repository
optional

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

Validations:

  • boolean

sync_capsule
optional

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

Validations:

  • boolean

uploads
optional

Array of uploads to import

Validations:

  • Must be an Array of nested elements

uploads[id]
required

Validations:

  • String

uploads[size]
optional

Validations:

  • String

uploads[checksum]
optional

Validations:

  • String

uploads[name]
optional

Needs to only be set for file repositories

Validations:

  • String


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

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..