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/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
Required

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

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, yum, ostree, file, docker.

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_results
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, yum, ostree, file, docker.

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


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


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


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
Required

Array of upload ids to import

Validations:

  • Must be an array of any type

publish_repository
Optional

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

Validations:

  • boolean


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..