Organizations

>>>

GET /katello/api/organizations
List all organizations

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
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
description text
id integer
label string
name string
organization_id integer
title string
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

organization ID

Validations:

  • Must be a number.
>>>

POST /katello/api/organizations
Create organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
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[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[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type
organization[location_ids]
optional , nil allowed

Associated location IDs

Validations:

  • Must be an array of any type
organization[label]
optional

Validations:

  • String
simple_content_access DEPRECATED
optional

Whether to turn on Simple Content Access for the organization.

Validations:

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

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

organization ID

Validations:

  • Must be a number.
redhat_repository_url DEPRECATED
optional

Red Hat CDN URL

Validations:

  • String
simple_content_access DEPRECATED
optional

Whether Simple Content Access should be enabled for the organization.

Validations:

  • Must be one of: true, false, 1, 0.
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[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[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type
organization[location_ids]
optional , nil allowed

Associated location IDs

Validations:

  • Must be an array of any type
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Organization ID

Validations:

  • Must be a number.
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Organization ID

Validations:

  • Must be a 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
search
optional

Search pattern (defaults to '*')

Validations:

  • String
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
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
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
label
optional

Organization label

Validations:

  • String
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

ID of the Organization

Validations:

  • String
>>>

PUT /katello/api/organizations/:id/cdn_configuration
Update the CDN configuration

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

ID of the Organization

Validations:

  • String
type
required

CDN configuration type. One of redhat_cdn, network_sync, export_sync, custom_cdn.

Validations:

  • String
url
optional

Upstream foreman server to sync CDN content from. Relevant only for 'upstream_server' type.

Validations:

  • String
username
optional

Username for authentication. Relevant only for 'upstream_server' type.

Validations:

  • String
password
optional

Password for authentication. Relevant only for 'upstream_server' type.

Validations:

  • String
upstream_organization_label
optional

Upstream organization to sync CDN content from. Relevant only for 'upstream_server' type.

Validations:

  • String
upstream_content_view_label
optional

Upstream Content View Label, default: Default_Organization_View. Relevant only for 'upstream_server' type.

Validations:

  • String
upstream_lifecycle_environment_label
optional

Upstream Lifecycle Environment, default: Library. Relevant only for 'upstream_server' type.

Validations:

  • String
ssl_ca_credential_id
optional

Content Credential to use for SSL CA. Relevant only for 'upstream_server' type.

Validations:

  • Integer
custom_cdn_auth_enabled
optional

If product certificates should be used to authenticate to a custom CDN.

Validations:

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

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer