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


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

Params

Param Name Description
id
Required

organization ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • String

organization[user_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Capsule IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

organization[media_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Media IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

organization[label]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • String


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

Params

Param Name Description
id
Required

organization ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

redhat_repository_url
Optional

Red Hat CDN URL

Validations:

  • String

organization
Required

Validations:

  • Hash

organization[name]
Optional

Validations:

  • String

organization[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • String

organization[user_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Capsule IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

organization[media_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Media IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

organization[parent_id]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • number.


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


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


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