GET /katello/api/alternate_content_sources 200 { "total": 5, "subtotal": 5, "selectable": 5, "page": 1, "per_page": 20, "error": null, "search": null, "sort": { "by": "name", "order": "asc" }, "results": [ { "name": "File ACS", "alternate_content_source_type": "custom", "content_type": "file", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [], "upstream_username": "admin", "smart_proxies": [], "verify_ssl": true, "use_http_proxies": null, "id": 175019167, "label": "file_acs_fixture", "description": null, "ssl_ca_cert": { "id": 70104267, "name": "Fedora CA" }, "ssl_client_cert": { "id": 60750479, "name": "Fedora Cert" }, "ssl_client_key": { "id": 81778079, "name": "Fedora Key" }, "last_refresh": null }, { "name": "File Simplified ACS", "alternate_content_source_type": "simplified", "content_type": "file", "products": [], "smart_proxies": [], "use_http_proxies": null, "id": 364480250, "label": "file_simplified_acs_fixture", "description": null, "last_refresh": null }, { "name": "Yum ACS", "alternate_content_source_type": "custom", "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [ "content/", "isos/", "packages/" ], "upstream_username": "admin", "smart_proxies": [], "verify_ssl": true, "use_http_proxies": null, "id": 209079975, "label": "yum_acs_fixture", "description": null, "ssl_ca_cert": { "id": 70104267, "name": "Fedora CA" }, "ssl_client_cert": { "id": 60750479, "name": "Fedora Cert" }, "ssl_client_key": { "id": 81778079, "name": "Fedora Key" }, "last_refresh": null }, { "name": "Yum ACS RHUI", "alternate_content_source_type": "rhui", "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [], "upstream_username": "admin", "smart_proxies": [], "verify_ssl": true, "use_http_proxies": null, "id": 350917440, "label": "yum_acs_fixture_rhui", "description": null, "ssl_ca_cert": { "id": 70104267, "name": "Fedora CA" }, "ssl_client_cert": { "id": 60750479, "name": "Fedora Cert" }, "ssl_client_key": { "id": 81778079, "name": "Fedora Key" }, "last_refresh": null }, { "name": "Yum Simplified ACS", "alternate_content_source_type": "simplified", "content_type": "yum", "products": [], "smart_proxies": [], "use_http_proxies": null, "id": 508877521, "label": "yum_simplified_acs_fixture", "description": null, "last_refresh": null } ] }
Param name | Description |
---|---|
name
optional |
Name of the alternate content source Validations:
|
search
optional |
Search string Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return Validations:
|
order
optional |
Sort field and order, eg. 'id DESC' Validations:
|
full_result
optional |
Whether or not to show all results Validations:
|
sort_by
optional |
Field to sort the results on Validations:
|
sort_order
optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
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/209079975 200 { "name": "Yum ACS", "alternate_content_source_type": "custom", "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [ "content/", "isos/", "packages/" ], "upstream_username": "admin", "smart_proxies": [], "verify_ssl": true, "use_http_proxies": null, "id": 209079975, "label": "yum_acs_fixture", "description": null, "ssl_ca_cert": { "id": 70104267, "name": "Fedora CA" }, "ssl_client_cert": { "id": 60750479, "name": "Fedora Cert" }, "ssl_client_key": { "id": 81778079, "name": "Fedora Key" }, "last_refresh": null, "upstream_password_exists": true }
Param name | Description |
---|---|
id
required |
Alternate content source ID Validations:
|
POST /katello/api/alternate_content_sources { "name": "Yum ACS RHUI", "smart_proxy_ids": [ 767380118 ], "http_proxy_id": 1022235409, "ssl_ca_cert_id": 70104267, "ssl_client_cert_id": 60750479, "ssl_client_key_id": 81778079, "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [], "alternate_content_source_type": "rhui", "verify_ssl": true, "use_http_proxies": null, "upstream_username": "admin", "upstream_password": "changeme", "alternate_content_source": { "name": "Yum ACS RHUI", "ssl_ca_cert_id": 70104267, "ssl_client_cert_id": 60750479, "ssl_client_key_id": 81778079, "base_url": "https://fixtures.pulpproject.org/", "subpaths": [], "content_type": "yum", "alternate_content_source_type": "rhui", "verify_ssl": true, "upstream_username": "admin", "upstream_password": "changeme", "use_http_proxies": null, "smart_proxy_ids": [ 767380118 ] } } 201 { "name": "Yum ACS RHUI", "alternate_content_source_type": "rhui", "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [], "upstream_username": "admin", "smart_proxies": [], "verify_ssl": true, "use_http_proxies": null, "id": null, "label": null, "description": null, "ssl_ca_cert": { "id": 70104267, "name": "Fedora CA" }, "ssl_client_cert": { "id": 60750479, "name": "Fedora Cert" }, "ssl_client_key": { "id": 81778079, "name": "Fedora Key" }, "last_refresh": null, "upstream_password_exists": true }
Param name | Description |
---|---|
content_type
optional |
The content type for the Alternate Content Source Validations:
|
alternate_content_source_type
optional |
The Alternate Content Source type Validations:
|
name
optional |
Name of the alternate content source Validations:
|
description
optional |
Description for the alternate content source Validations:
|
base_url
optional |
Base URL for finding alternate content Validations:
|
subpaths
optional |
Path suffixes for finding alternate content Validations:
|
smart_proxy_ids
optional |
Ids of smart proxies to associate Validations:
|
smart_proxy_names
optional |
Names of smart proxies to associate Validations:
|
upstream_username
optional |
Basic authentication username Validations:
|
upstream_password
optional |
Basic authentication password Validations:
|
ssl_ca_cert_id
optional |
Identifier of the content credential containing the SSL CA Cert Validations:
|
ssl_client_cert_id
optional |
Identifier of the content credential containing the SSL Client Cert Validations:
|
ssl_client_key_id
optional |
Identifier of the content credential containing the SSL Client Key Validations:
|
verify_ssl
optional |
If SSL should be verified for the upstream URL Validations:
|
use_http_proxies
optional |
If the smart proxies' assigned HTTP proxies should be used Validations:
|
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:
|
PUT /katello/api/alternate_content_sources/209079975 { "name": "Yum ACS", "smart_proxy_ids": [ 767380118 ], "http_proxy_id": 1022235412, "ssl_ca_cert_id": 70104267, "ssl_client_cert_id": 60750479, "ssl_client_key_id": 81778079, "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [ "not a path", "/not a path" ], "alternate_content_source_type": "custom", "verify_ssl": true, "upstream_username": "admin", "upstream_password": "changeme", "alternate_content_source": { "name": "Yum ACS", "ssl_ca_cert_id": 70104267, "ssl_client_cert_id": 60750479, "ssl_client_key_id": 81778079, "base_url": "https://fixtures.pulpproject.org/", "subpaths": [ "not a path", "/not a path" ], "content_type": "yum", "alternate_content_source_type": "custom", "verify_ssl": true, "upstream_username": "admin", "upstream_password": "changeme", "smart_proxy_ids": [ 767380118 ] } } 422 { "displayMessage": "Validation failed: Subpaths All subpaths must have a slash at the end and none at the front", "errors": { "subpaths": [ "All subpaths must have a slash at the end and none at the front" ] } }
Param name | Description |
---|---|
name
optional |
Name of the alternate content source Validations:
|
description
optional |
Description for the alternate content source Validations:
|
base_url
optional |
Base URL for finding alternate content Validations:
|
subpaths
optional |
Path suffixes for finding alternate content Validations:
|
smart_proxy_ids
optional |
Ids of smart proxies to associate Validations:
|
smart_proxy_names
optional |
Names of smart proxies to associate Validations:
|
upstream_username
optional |
Basic authentication username Validations:
|
upstream_password
optional |
Basic authentication password Validations:
|
ssl_ca_cert_id
optional |
Identifier of the content credential containing the SSL CA Cert Validations:
|
ssl_client_cert_id
optional |
Identifier of the content credential containing the SSL Client Cert Validations:
|
ssl_client_key_id
optional |
Identifier of the content credential containing the SSL Client Key Validations:
|
verify_ssl
optional |
If SSL should be verified for the upstream URL Validations:
|
use_http_proxies
optional |
If the smart proxies' assigned HTTP proxies should be used Validations:
|
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:
|
id
required |
Alternate content source ID Validations:
|
DELETE /katello/api/alternate_content_sources/209079975 { "alternate_content_source": {} } 200 { "name": "Yum ACS", "alternate_content_source_type": "custom", "content_type": "yum", "base_url": "https://fixtures.pulpproject.org/", "subpaths": [ "content/", "isos/", "packages/" ], "upstream_username": "admin", "smart_proxies": [], "verify_ssl": true, "use_http_proxies": null, "id": 209079975, "label": "yum_acs_fixture", "description": null, "ssl_ca_cert": { "id": 70104267, "name": "Fedora CA" }, "ssl_client_cert": { "id": 60750479, "name": "Fedora Cert" }, "ssl_client_key": { "id": 81778079, "name": "Fedora Key" }, "last_refresh": null, "upstream_password_exists": true }
Param name | Description |
---|---|
id
required |
Alternate content source ID Validations:
|
POST /katello/api/alternate_content_sources/209079975/refresh { "alternate_content_source": {} } 202 { "id": null, "label": null, "pending": null, "username": null, "started_at": null, "ended_at": null, "state": null, "result": null, "progress": null, "input": null, "output": {}, "humanized": null, "cli_example": null, "available_actions": { "cancellable": null, "resumable": null } }
Param name | Description |
---|---|
id
required |
Alternate content source ID Validations:
|