Alternate_content_sources

>>>

GET /katello/api/alternate_content_sources
List alternate content sources.

Params

Param name Description
name
optional

Name of the alternate content source

Validations:

  • String
search
optional

Search string

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.
order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String
full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.
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

Search fields

Field name Type Possible values
alternate_content_source_type string
base_url string
content_type string
description text
label string
name string
product_id integer
product_name string
smart_proxy_id integer
smart_proxy_name string
subpath string
upstream_username string
>>>

GET /katello/api/alternate_content_sources/:id
Show an alternate content source.

Params

Param name Description
id
required

Alternate content source ID

Validations:

  • Must be a number.
>>>

POST /katello/api/alternate_content_sources
Create an alternate content source to download content from during repository syncing. Note: alternate content sources are global and affect ALL sync actions on their smart proxies regardless of organization.

Params

Param name Description
content_type
optional

The content type for the Alternate Content Source

Validations:

  • Must be one of: file, yum.
alternate_content_source_type
optional

The Alternate Content Source type

Validations:

  • Must be one of: custom, simplified, rhui.
name
optional

Name of the alternate content source

Validations:

  • String
description
optional

Description for the alternate content source

Validations:

  • String
base_url
optional

Base URL for finding alternate content

Validations:

  • String
subpaths
optional

Path suffixes for finding alternate content

Validations:

  • Must be an array of any type
smart_proxy_ids
optional

Ids of smart proxies to associate

Validations:

  • Must be an array of any type
smart_proxy_names
optional

Names of smart proxies to associate

Validations:

  • Must be an array of any type
upstream_username
optional

Basic authentication username

Validations:

  • String
upstream_password
optional

Basic authentication password

Validations:

  • String
ssl_ca_cert_id
optional

Identifier of the content credential containing the SSL CA Cert

Validations:

  • Must be a number.
ssl_client_cert_id
optional

Identifier of the content credential containing the SSL Client Cert

Validations:

  • Must be a number.
ssl_client_key_id
optional

Identifier of the content credential containing the SSL Client Key

Validations:

  • Must be a number.
verify_ssl
optional

If SSL should be verified for the upstream URL

Validations:

  • Must be one of: true, false, 1, 0.
use_http_proxies
optional

If the smart proxies' assigned HTTP proxies should be used

Validations:

  • Must be one of: true, false, 1, 0.
product_ids
optional

IDs of products to copy repository information from into a Simplified Alternate Content Source. Products must include at least one repository of the chosen content type.

Validations:

  • Must be an array of any type
>>>

PUT /katello/api/alternate_content_sources/:id
Update an alternate content source.

Params

Param name Description
name
optional

Name of the alternate content source

Validations:

  • String
description
optional

Description for the alternate content source

Validations:

  • String
base_url
optional

Base URL for finding alternate content

Validations:

  • String
subpaths
optional

Path suffixes for finding alternate content

Validations:

  • Must be an array of any type
smart_proxy_ids
optional

Ids of smart proxies to associate

Validations:

  • Must be an array of any type
smart_proxy_names
optional

Names of smart proxies to associate

Validations:

  • Must be an array of any type
upstream_username
optional

Basic authentication username

Validations:

  • String
upstream_password
optional

Basic authentication password

Validations:

  • String
ssl_ca_cert_id
optional

Identifier of the content credential containing the SSL CA Cert

Validations:

  • Must be a number.
ssl_client_cert_id
optional

Identifier of the content credential containing the SSL Client Cert

Validations:

  • Must be a number.
ssl_client_key_id
optional

Identifier of the content credential containing the SSL Client Key

Validations:

  • Must be a number.
verify_ssl
optional

If SSL should be verified for the upstream URL

Validations:

  • Must be one of: true, false, 1, 0.
use_http_proxies
optional

If the smart proxies' assigned HTTP proxies should be used

Validations:

  • Must be one of: true, false, 1, 0.
product_ids
optional

IDs of products to copy repository information from into a Simplified Alternate Content Source. Products must include at least one repository of the chosen content type.

Validations:

  • Must be an array of any type
id
required

Alternate content source ID

Validations:

  • Must be a number.
>>>

DELETE /katello/api/alternate_content_sources/:id
Destroy an alternate content source.

Params

Param name Description
id
required

Alternate content source ID

Validations:

  • Must be a number.
>>>

POST /katello/api/alternate_content_sources/:id/refresh
Refresh an alternate content source. Refreshing, like repository syncing, is required before using an alternate content source.

Params

Param name Description
id
required

Alternate content source ID

Validations:

  • Must be a number.