GET /katello/api/organizations
List all organizations

Params

Param name Description
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


GET /katello/api/organizations/:id
Show organization

Params

Param name Description
id
required

organization ID

Validations:

  • number.


POST /katello/api/organizations
Create organization

Params

Param name Description
name
required

name

Validations:

  • String

label
optional

unique label

Validations:

  • String

description
optional

description

Validations:

  • String

organization
required

Validations:

  • Hash

organization[name]
required

Validations:

  • String

organization[description]
optional , nil allowed

Validations:

  • String

organization[user_ids]
optional , nil allowed

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Compute resource IDs

Validations:

  • Must be an array of any type

organization[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
optional , nil allowed

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
optional , nil allowed

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
optional , nil allowed

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Subnet IDs

Validations:

  • Must be an array of any type

organization[label]
optional , nil allowed

Validations:

  • String


PUT /katello/api/organizations/:id
Update organization

Params

Param name Description
id
required

organization ID

Validations:

  • number.

redhat_repository_url
optional

Red Hat CDN URL

Validations:

  • String

organization
required

Validations:

  • Hash

organization[name]
optional

Validations:

  • String

organization[description]
optional , nil allowed

Validations:

  • String

organization[user_ids]
optional , nil allowed

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Compute resource IDs

Validations:

  • Must be an array of any type

organization[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
optional , nil allowed

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
optional , nil allowed

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
optional , nil allowed

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Subnet IDs

Validations:

  • Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID

Validations:

  • number.

organization[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type


DELETE /katello/api/organizations/:id
Delete an organization

Params

Param name Description
id
required

Organization ID

Validations:

  • number.


PUT /katello/api/organizations/:id/repo_discover
Discover Repositories

Params

Param name Description
id
required

Organization ID

Validations:

  • number.

url
optional

Base URL to perform repo discovery on

Validations:

  • String

content_type
optional

One of yum or docker

Validations:

  • String

upstream_username
optional

Username to access URL

Validations:

  • String

upstream_password
optional

Password to access URL

Validations:

  • String


PUT /katello/api/organizations/:label/cancel_repo_discover
Cancel repository discovery

Params

Param name Description
label
optional

Organization label

Validations:

  • String

url
optional

base url to perform repo discovery on

Validations:

  • String


GET /katello/api/organizations/:label/download_debug_certificate
Download a debug certificate

Params

Param name Description
label
optional

Organization label

Validations:

  • String


GET /katello/api/organizations/:id/releases
List available releases in the organization

Params

Param name Description
id
required

ID of the Organization

Validations:

  • String


POST /katello/api/organizations/:id/autoattach_subscriptions DEPRECATED
Auto-attach available subscriptions to all hosts within an organization. Asynchronous operation.


GET /katello/api/organizations/:id/redhat_provider
List all :resource_id