GET /katello/api/organizations/114267492/products
200
{
"total": 1,
"subtotal": 1,
"selectable": 1,
"page": 1,
"per_page": 20,
"error": null,
"search": null,
"sort": {
"by": "name",
"order": "asc"
},
"results": [
{
"id": 785257261,
"cp_id": "123123123001",
"name": "Fedora",
"label": "fedora_label",
"description": "An open source Linux distribution.",
"provider_id": 36826545,
"sync_plan_id": null,
"sync_summary": {},
"gpg_key_id": null,
"ssl_ca_cert_id": null,
"ssl_client_cert_id": null,
"ssl_client_key_id": null,
"sync_state": null,
"last_sync": null,
"last_sync_words": null,
"organization_id": 114267492,
"organization": {
"name": "Empty Organization",
"label": "Empty_Organization",
"id": 114267492
},
"sync_plan": null,
"repository_count": 13
}
]
}
| Param name | Description |
|---|---|
|
organization_id
required |
Filter products by organization Validations:
|
|
subscription_id
optional |
Filter products by subscription Validations:
|
|
name
optional |
Filter products by name Validations:
|
|
enabled
optional |
Return enabled products only Validations:
|
|
custom
optional |
Return custom products only Validations:
|
|
redhat_only
optional |
Return Red Hat (non-custom) products only Validations:
|
|
include_available_content
optional |
Whether to include available content attribute in results Validations:
|
|
sync_plan_id
optional |
Filter products by sync plan id Validations:
|
|
available_for
optional |
Interpret specified object to return only Products that can be associated with specified object. Only 'sync_plan' is supported. 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 |
|---|---|---|
| description | text | |
| label | string | |
| name | string | |
| organization_id | integer | |
| redhat | true, false |
POST /katello/api/products
{
"product": {
"name": "fedora product",
"description": "this is my cool new product.",
"label": "product_label"
},
"organization_id": 114267492
}
201
{
"sync_state_aggregated": "stopped",
"redhat": false,
"id": null,
"cp_id": null,
"name": "fedora product",
"label": "product_label",
"description": "this is my cool new product.",
"provider_id": 36826545,
"sync_plan_id": null,
"sync_summary": {},
"gpg_key_id": null,
"ssl_ca_cert_id": null,
"ssl_client_cert_id": null,
"ssl_client_key_id": null,
"sync_state": null,
"last_sync": null,
"last_sync_words": null,
"organization_id": 114267492,
"organization": {
"name": "Empty Organization",
"label": "Empty_Organization",
"id": 114267492
},
"sync_plan": null,
"repository_count": 0,
"created_at": null,
"updated_at": null,
"product_content": [],
"available_content": [],
"repositories": [],
"provider": {
"name": "Anonymous"
},
"sync_status": {
"id": null,
"product_id": null,
"progress": null,
"sync_id": null,
"state": null,
"raw_state": null,
"start_time": null,
"finish_time": null,
"duration": null,
"display_size": null,
"size": null,
"is_running": null,
"error_details": null
},
"permissions": {
"view_products": true,
"edit_products": true,
"destroy_products": true,
"sync_products": true
},
"published_content_view_ids": [],
"has_last_affected_repo_in_filter": false,
"active_task_count": 0
}
| Param name | Description |
|---|---|
|
organization_id
required |
ID of the organization Validations:
|
|
description
optional |
Product description Validations:
|
|
gpg_key_id
optional , nil allowed |
Identifier of the GPG key Validations:
|
|
ssl_ca_cert_id
optional , nil allowed |
Idenifier of the SSL CA Cert Validations:
|
|
ssl_client_cert_id
optional , nil allowed |
Identifier of the SSL Client Cert Validations:
|
|
ssl_client_key_id
optional , nil allowed |
Identifier of the SSL Client Key Validations:
|
|
sync_plan_id
optional , nil allowed |
Plan numeric identifier Validations:
|
|
name
required |
Product name Validations:
|
|
label
optional |
Validations:
|
GET /katello/api/products/785257261 204
| Param name | Description |
|---|---|
|
organization_id
optional |
Organization ID Validations:
|
|
id
required |
product numeric identifier Validations:
|
PUT /katello/api/products/785257261
{
"product": {
"name": "New Name"
}
}
204
| Param name | Description |
|---|---|
|
id
required |
product numeric identifier Validations:
|
|
description
optional |
Product description Validations:
|
|
gpg_key_id
optional , nil allowed |
Identifier of the GPG key Validations:
|
|
ssl_ca_cert_id
optional , nil allowed |
Idenifier of the SSL CA Cert Validations:
|
|
ssl_client_cert_id
optional , nil allowed |
Identifier of the SSL Client Cert Validations:
|
|
ssl_client_key_id
optional , nil allowed |
Identifier of the SSL Client Key Validations:
|
|
sync_plan_id
optional , nil allowed |
Plan numeric identifier Validations:
|
|
name
optional |
Product name Validations:
|
DELETE /katello/api/products/785257261
{
"product": {}
}
204
| Param name | Description |
|---|---|
|
id
optional |
product numeric identifier Validations:
|
POST /katello/api/products/785257261/sync
{
"product": {}
}
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 |
product ID Validations:
|