diff --git a/actions/activation_keys.add_subscriptions.yaml b/actions/activation_keys.add_subscriptions.yaml index 141bb9e..e50dff4 100644 --- a/actions/activation_keys.add_subscriptions.yaml +++ b/actions/activation_keys.add_subscriptions.yaml @@ -46,11 +46,11 @@ parameters: "description: Array of subscriptions to add parameters: id: + description: Subscription Pool uuid required: false type: string - description: Subscription Pool uuid quantity: + description: Quantity of this subscriptions to add required: false type: number - description: Quantity of this subscriptions to add " \ No newline at end of file diff --git a/actions/activation_keys.content_override.yaml b/actions/activation_keys.content_override.yaml index ecfcb8e..ab97f4d 100644 --- a/actions/activation_keys.content_override.yaml +++ b/actions/activation_keys.content_override.yaml @@ -31,41 +31,26 @@ parameters: type: number required: true description: "ID of the activation key" - content_override: - type: object - required: false - description: > - "description: Content override parameters - parameters: - content_label: - required: true - type: string - description: Label of the content - value: - required: true - type: string - description: Override to a boolean value or 'default' - " content_overrides: type: array required: false description: > - "description: Array of Content override parameters + "description: Array of Content override parameters to be added in bulk parameters: content_label: + description: Label of the content required: true type: string - description: Label of the content - name: + value: + description: Override value. Provide a boolean value if name is 'enabled' required: false type: string + name: description: Override parameter key or name. Note if name is not provided the defaultname will be 'enabled' - value: required: false type: string - description: Override value. Provide a boolean value if name is 'enabled' remove: + description: Set true to remove an override and reset it to 'default' required: false type: boolean - description: Set true to remove an override and reset it to 'default' " \ No newline at end of file diff --git a/actions/activation_keys.create.yaml b/actions/activation_keys.create.yaml index 5bd9ca4..b7334c3 100644 --- a/actions/activation_keys.create.yaml +++ b/actions/activation_keys.create.yaml @@ -58,4 +58,28 @@ parameters: unlimited_hosts: type: boolean required: false - description: "can the activation key have unlimited hosts" \ No newline at end of file + description: "can the activation key have unlimited hosts" + release_version: + type: string + required: false + description: "content release version" + service_level: + type: string + required: false + description: "service level" + auto_attach: + type: boolean + required: false + description: "auto attach subscriptions upon registration" + purpose_usage: + type: string + required: false + description: "Sets the system purpose usage" + purpose_role: + type: string + required: false + description: "Sets the system purpose usage" + purpose_addons: + type: array + required: false + description: "Sets the system add-ons" \ No newline at end of file diff --git a/actions/activation_keys.remove_subscriptions.yaml b/actions/activation_keys.remove_subscriptions.yaml index c5e1483..bad6b63 100644 --- a/actions/activation_keys.remove_subscriptions.yaml +++ b/actions/activation_keys.remove_subscriptions.yaml @@ -42,7 +42,7 @@ parameters: "description: Array of subscriptions to add parameters: id: + description: Subscription Pool uuid required: false type: string - description: Subscription Pool uuid " \ No newline at end of file diff --git a/actions/activation_keys.subscriptions_create.yaml b/actions/activation_keys.subscriptions_create.yaml index 9e41f0f..1a9b9e0 100644 --- a/actions/activation_keys.subscriptions_create.yaml +++ b/actions/activation_keys.subscriptions_create.yaml @@ -46,11 +46,11 @@ parameters: "description: Array of subscriptions to add parameters: id: + description: Subscription Pool uuid required: true type: string - description: Subscription Pool uuid quantity: + description: Quantity of this subscriptions to add required: true type: number - description: Quantity of this subscriptions to add " \ No newline at end of file diff --git a/actions/activation_keys.subscriptions_index.yaml b/actions/activation_keys.subscriptions_index.yaml index 0452afc..f2c7181 100644 --- a/actions/activation_keys.subscriptions_index.yaml +++ b/actions/activation_keys.subscriptions_index.yaml @@ -57,7 +57,7 @@ parameters: description: "How to order the sorted results (e.g. ASC for ascending)" organization_id: type: number - required: true + required: false description: "Organization ID" host_id: type: string diff --git a/actions/activation_keys.update.yaml b/actions/activation_keys.update.yaml index 38ceae5..8ff1b19 100644 --- a/actions/activation_keys.update.yaml +++ b/actions/activation_keys.update.yaml @@ -70,4 +70,16 @@ parameters: auto_attach: type: boolean required: false - description: "auto attach subscriptions upon registration" \ No newline at end of file + description: "auto attach subscriptions upon registration" + purpose_usage: + type: string + required: false + description: "Sets the system purpose usage" + purpose_role: + type: string + required: false + description: "Sets the system purpose usage" + purpose_addons: + type: array + required: false + description: "Sets the system add-ons" \ No newline at end of file diff --git a/actions/ansible_collections.compare.yaml b/actions/ansible_collections.compare.yaml new file mode 100644 index 0000000..56d4309 --- /dev/null +++ b/actions/ansible_collections.compare.yaml @@ -0,0 +1,37 @@ +--- +description: "List :resource (resource: GET /katello/api/ansible_collections/compare)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: ansible_collections.compare +pack: foreman +parameters: + operation: + type: string + default: ansible_collections.compare + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + content_view_version_ids: + type: array + required: false + description: "content view versions to compare" + repository_id: + type: number + required: false + description: "Library repository id to restrict comparisons to" \ No newline at end of file diff --git a/actions/ansible_collections.index.yaml b/actions/ansible_collections.index.yaml new file mode 100644 index 0000000..7fe0103 --- /dev/null +++ b/actions/ansible_collections.index.yaml @@ -0,0 +1,85 @@ +--- +description: "List ansible_collections (resource: GET /katello/api/ansible_collections)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: ansible_collections.index +pack: foreman +parameters: + operation: + type: string + default: ansible_collections.index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + organization_id: + type: number + required: false + description: "organization identifier" + content_view_version_id: + type: number + required: false + description: "content view version identifier" + content_view_filter_id: + type: number + required: false + description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" + repository_id: + type: number + required: false + description: "repository identifier" + environment_id: + type: number + required: false + description: "environment identifier" + ids: + type: array + required: false + description: "ids to filter content by" + search: + type: string + required: false + description: "Search string" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" + order: + type: string + required: false + description: "Sort field and order, eg. 'id DESC'" + full_result: + type: boolean + required: false + description: "Whether or not to show all results" + sort_by: + type: string + required: false + description: "Field to sort the results on" + sort_order: + type: string + required: false + description: "How to order the sorted results (e.g. ASC for ascending)" \ No newline at end of file diff --git a/actions/ansible_collections.show.yaml b/actions/ansible_collections.show.yaml new file mode 100644 index 0000000..d0944ee --- /dev/null +++ b/actions/ansible_collections.show.yaml @@ -0,0 +1,37 @@ +--- +description: "Show an ansible collection (resource: GET /katello/api/ansible_collections/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: ansible_collections.show +pack: foreman +parameters: + operation: + type: string + default: ansible_collections.show + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + repository_id: + type: number + required: false + description: "repository identifier" + id: + type: string + required: true + description: "an ansible collection identifier" \ No newline at end of file diff --git a/actions/ansible_inventories.hosts.yaml b/actions/ansible_inventories.hosts.yaml new file mode 100644 index 0000000..91d58a3 --- /dev/null +++ b/actions/ansible_inventories.hosts.yaml @@ -0,0 +1,45 @@ +--- +description: "Show Ansible inventory for hosts (resource: POST /api/ansible_inventories/hosts)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: ansible_inventories.hosts +pack: foreman +parameters: + operation: + type: string + default: ansible_inventories.hosts + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_ids: + type: array + required: true + description: "IDs of hosts included in inventory" + hostgroup_ids: + type: array + required: true + description: "IDs of hostgroups included in inventory" \ No newline at end of file diff --git a/actions/ansible_inventories.schedule.yaml b/actions/ansible_inventories.schedule.yaml new file mode 100644 index 0000000..8dee150 --- /dev/null +++ b/actions/ansible_inventories.schedule.yaml @@ -0,0 +1,45 @@ +--- +description: "Schedule generating of Ansible Inventory report (resource: POST /api/ansible_inventories/schedule)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: ansible_inventories.schedule +pack: foreman +parameters: + operation: + type: string + default: ansible_inventories.schedule + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + input_values: + type: object + required: false + description: "Hash of input values of type input=>value" + report_format: + type: string + required: false + description: "Report format, defaults to 'json'" \ No newline at end of file diff --git a/actions/api.home_index.yaml b/actions/api.home_index.yaml index c9acdb7..71026b5 100644 --- a/actions/api.home_index.yaml +++ b/actions/api.home_index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/architectures.create.yaml b/actions/architectures.create.yaml index 5c4fc01..50c30de 100644 --- a/actions/architectures.create.yaml +++ b/actions/architectures.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture: type: object required: true @@ -42,11 +42,11 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' operatingsystem_ids: + description: Operating system IDs required: false type: array - description: Operating system IDs " \ No newline at end of file diff --git a/actions/architectures.destroy.yaml b/actions/architectures.destroy.yaml index b02fc04..e26f4ca 100644 --- a/actions/architectures.destroy.yaml +++ b/actions/architectures.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/architectures.images_architecture_id_showimages.yaml b/actions/architectures.images_architecture_id_showimages.yaml index 0756b75..d8e6a13 100644 --- a/actions/architectures.images_architecture_id_showimages.yaml +++ b/actions/architectures.images_architecture_id_showimages.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/architectures.images_index.yaml b/actions/architectures.images_index.yaml index 49f3c16..213d4f6 100644 --- a/actions/architectures.images_index.yaml +++ b/actions/architectures.images_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource_id: type: string required: false @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/architectures.index.yaml b/actions/architectures.index.yaml index aaf9cbd..0066c38 100644 --- a/actions/architectures.index.yaml +++ b/actions/architectures.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,15 +42,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" operatingsystem_id: type: string required: false diff --git a/actions/architectures.operatingsystems_index.yaml b/actions/architectures.operatingsystems_index.yaml index c817476..f986f62 100644 --- a/actions/architectures.operatingsystems_index.yaml +++ b/actions/architectures.operatingsystems_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture_id: type: string required: true @@ -62,13 +62,13 @@ parameters: "description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value " search: type: string @@ -77,12 +77,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/architectures.show.yaml b/actions/architectures.show.yaml index 2d36015..375d2ab 100644 --- a/actions/architectures.show.yaml +++ b/actions/architectures.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/architectures.update.yaml b/actions/architectures.update.yaml index 94ee872..9f0c4c0 100644 --- a/actions/architectures.update.yaml +++ b/actions/architectures.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,11 +45,11 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' operatingsystem_ids: + description: Operating system IDs required: false type: array - description: Operating system IDs " \ No newline at end of file diff --git a/actions/audits.index.yaml b/actions/audits.index.yaml index ec5f9bd..c049823 100644 --- a/actions/audits.index.yaml +++ b/actions/audits.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/audits.show.yaml b/actions/audits.show.yaml index 34e528a..4818ea9 100644 --- a/actions/audits.show.yaml +++ b/actions/audits.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/auth_source_externals.index.yaml b/actions/auth_source_externals.index.yaml index 2038976..2bab6a2 100644 --- a/actions/auth_source_externals.index.yaml +++ b/actions/auth_source_externals.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/auth_source_externals.show.yaml b/actions/auth_source_externals.show.yaml index f480849..8157aa5 100644 --- a/actions/auth_source_externals.show.yaml +++ b/actions/auth_source_externals.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/auth_source_externals.update.yaml b/actions/auth_source_externals.update.yaml index 1e97c69..047041c 100644 --- a/actions/auth_source_externals.update.yaml +++ b/actions/auth_source_externals.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,16 +44,16 @@ parameters: description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: '' required: false type: string - description: '' - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/auth_source_externals.users_index.yaml b/actions/auth_source_externals.users_index.yaml index 19adbd2..58c054c 100644 --- a/actions/auth_source_externals.users_index.yaml +++ b/actions/auth_source_externals.users_index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/auth_source_internals.index.yaml b/actions/auth_source_internals.index.yaml index cac81e5..036d662 100644 --- a/actions/auth_source_internals.index.yaml +++ b/actions/auth_source_internals.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/auth_source_internals.show.yaml b/actions/auth_source_internals.show.yaml index 6babe2f..9c97f44 100644 --- a/actions/auth_source_internals.show.yaml +++ b/actions/auth_source_internals.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/auth_source_ldaps.create.yaml b/actions/auth_source_ldaps.create.yaml index c6b219f..96622df 100644 --- a/actions/auth_source_ldaps.create.yaml +++ b/actions/auth_source_ldaps.create.yaml @@ -30,95 +30,95 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" auth_source_ldap: type: object required: true description: > "description: parameters: - attr_mail: - required: false - type: string - description: required if onthefly_register is true - tls: - required: false - type: boolean + name: description: '' - account: - required: false + required: true type: string + host: description: '' - name: required: true type: string + port: + description: defaults to 389 + required: false + type: number + account: description: '' - server_type: required: false type: string - description: type of the LDAP server - use_netgroups: - required: false - type: boolean - description: use NIS netgroups instead of posix groups, applicable only when server_typeis posix or free_ipa - groups_base: + base_dn: + description: '' required: false type: string - description: groups base DN - attr_photo: + account_password: + description: required if onthefly_register is true required: false type: string - description: '' - onthefly_register: + attr_login: + description: required if onthefly_register is true required: false - type: boolean - description: '' - host: - required: true type: string - description: '' - account_password: + attr_firstname: + description: required if onthefly_register is true required: false type: string + attr_lastname: description: required if onthefly_register is true - attr_firstname: required: false type: string + attr_mail: description: required if onthefly_register is true - usergroup_sync: + required: false + type: string + attr_photo: + description: '' + required: false + type: string + onthefly_register: + description: '' required: false type: boolean + usergroup_sync: description: sync external user groups on login - base_dn: required: false - type: string + type: boolean + tls: description: '' - attr_lastname: + required: false + type: boolean + groups_base: + description: groups base DN required: false type: string - description: required if onthefly_register is true - attr_login: + use_netgroups: + description: use NIS netgroups instead of posix groups, applicable only when server_typeis posix or free_ipa + required: false + type: boolean + server_type: + description: type of the LDAP server required: false type: string - description: required if onthefly_register is true - location_ids: + ldap_filter: + description: LDAP filter required: false - type: array + type: string + location_ids: description: REPLACE locations with given ids - port: - required: false - type: number - description: defaults to 389 - organization_ids: required: false type: array + organization_ids: description: REPLACE organizations with given ids. - ldap_filter: required: false - type: string - description: LDAP filter + type: array " \ No newline at end of file diff --git a/actions/auth_source_ldaps.destroy.yaml b/actions/auth_source_ldaps.destroy.yaml index da51bff..a80d052 100644 --- a/actions/auth_source_ldaps.destroy.yaml +++ b/actions/auth_source_ldaps.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/auth_source_ldaps.external_usergroups_auth_source_ldap_id_external_showusergroups.yaml b/actions/auth_source_ldaps.external_usergroups_auth_source_ldap_id_external_showusergroups.yaml index 45197ce..aa98abb 100644 --- a/actions/auth_source_ldaps.external_usergroups_auth_source_ldap_id_external_showusergroups.yaml +++ b/actions/auth_source_ldaps.external_usergroups_auth_source_ldap_id_external_showusergroups.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true diff --git a/actions/auth_source_ldaps.external_usergroups_index.yaml b/actions/auth_source_ldaps.external_usergroups_index.yaml index c0192c3..81abdde 100644 --- a/actions/auth_source_ldaps.external_usergroups_index.yaml +++ b/actions/auth_source_ldaps.external_usergroups_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true diff --git a/actions/auth_source_ldaps.index.yaml b/actions/auth_source_ldaps.index.yaml index 96a1ec1..cdf604f 100644 --- a/actions/auth_source_ldaps.index.yaml +++ b/actions/auth_source_ldaps.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/auth_source_ldaps.show.yaml b/actions/auth_source_ldaps.show.yaml index fa529f7..9fb79dd 100644 --- a/actions/auth_source_ldaps.show.yaml +++ b/actions/auth_source_ldaps.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/auth_source_ldaps.test.yaml b/actions/auth_source_ldaps.test.yaml index 95cb2a4..fa8afd5 100644 --- a/actions/auth_source_ldaps.test.yaml +++ b/actions/auth_source_ldaps.test.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/auth_source_ldaps.update.yaml b/actions/auth_source_ldaps.update.yaml index 77a9998..5af957d 100644 --- a/actions/auth_source_ldaps.update.yaml +++ b/actions/auth_source_ldaps.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,84 +44,84 @@ parameters: description: > "description: parameters: - attr_mail: + name: + description: '' required: false type: string - description: required if onthefly_register is true - tls: - required: false - type: boolean + host: description: '' - account: required: false type: string + port: + description: defaults to 389 + required: false + type: number + account: description: '' - name: required: false type: string + base_dn: description: '' - server_type: required: false type: string - description: type of the LDAP server - use_netgroups: + account_password: + description: required if onthefly_register is true required: false - type: boolean - description: use NIS netgroups instead of posix groups, applicable only when server_typeis posix or free_ipa - groups_base: + type: string + attr_login: + description: required if onthefly_register is true required: false type: string - description: groups base DN - attr_photo: + attr_firstname: + description: required if onthefly_register is true required: false type: string - description: '' - onthefly_register: + attr_lastname: + description: required if onthefly_register is true required: false - type: boolean - description: '' - host: + type: string + attr_mail: + description: required if onthefly_register is true required: false type: string + attr_photo: description: '' - account_password: required: false type: string - description: required if onthefly_register is true - attr_firstname: + onthefly_register: + description: '' required: false - type: string - description: required if onthefly_register is true + type: boolean usergroup_sync: + description: sync external user groups on login required: false type: boolean - description: sync external user groups on login - base_dn: + tls: + description: '' + required: false + type: boolean + groups_base: + description: groups base DN required: false type: string - description: '' - attr_lastname: + use_netgroups: + description: use NIS netgroups instead of posix groups, applicable only when server_typeis posix or free_ipa + required: false + type: boolean + server_type: + description: type of the LDAP server required: false type: string - description: required if onthefly_register is true - attr_login: + ldap_filter: + description: LDAP filter required: false type: string - description: required if onthefly_register is true location_ids: - required: false - type: array description: REPLACE locations with given ids - port: - required: false - type: number - description: defaults to 389 - organization_ids: required: false type: array + organization_ids: description: REPLACE organizations with given ids. - ldap_filter: required: false - type: string - description: LDAP filter + type: array " \ No newline at end of file diff --git a/actions/auth_source_ldaps.users_index.yaml b/actions/auth_source_ldaps.users_index.yaml index 15afe51..dd15d36 100644 --- a/actions/auth_source_ldaps.users_index.yaml +++ b/actions/auth_source_ldaps.users_index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/auth_sources.index.yaml b/actions/auth_sources.index.yaml index c10da10..aae0812 100644 --- a/actions/auth_sources.index.yaml +++ b/actions/auth_sources.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/bookmarks.create.yaml b/actions/bookmarks.create.yaml index 0a29fad..88d31da 100644 --- a/actions/bookmarks.create.yaml +++ b/actions/bookmarks.create.yaml @@ -30,31 +30,31 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" bookmark: type: object required: true description: > "description: parameters: - query: + name: + description: '' required: true type: string - description: '' controller: + description: '' required: true type: string + query: description: '' - name: required: true type: string - description: '' public: + description: '' required: false type: boolean - description: '' " \ No newline at end of file diff --git a/actions/bookmarks.destroy.yaml b/actions/bookmarks.destroy.yaml index e6d8182..978ee72 100644 --- a/actions/bookmarks.destroy.yaml +++ b/actions/bookmarks.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/bookmarks.index.yaml b/actions/bookmarks.index.yaml index 70d2e03..25549b4 100644 --- a/actions/bookmarks.index.yaml +++ b/actions/bookmarks.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/bookmarks.show.yaml b/actions/bookmarks.show.yaml index 810d98c..01acfaa 100644 --- a/actions/bookmarks.show.yaml +++ b/actions/bookmarks.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/bookmarks.update.yaml b/actions/bookmarks.update.yaml index 84d8dcc..c047db8 100644 --- a/actions/bookmarks.update.yaml +++ b/actions/bookmarks.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,20 +44,20 @@ parameters: description: > "description: parameters: - query: + name: + description: '' required: false type: string - description: '' controller: + description: '' required: false type: string + query: description: '' - name: required: false type: string - description: '' public: + description: '' required: false type: boolean - description: '' " \ No newline at end of file diff --git a/actions/capsules.capsule_content_add_lifecycle_environment.yaml b/actions/capsules.capsule_content_add_lifecycle_environment.yaml index 8d6a905..2577c2a 100644 --- a/actions/capsules.capsule_content_add_lifecycle_environment.yaml +++ b/actions/capsules.capsule_content_add_lifecycle_environment.yaml @@ -1,5 +1,5 @@ --- -description: "Add lifecycle environments to the capsule (resource: POST /katello/api/capsules/:id/content/lifecycle_environments)" +description: "Add lifecycle environments to the smart proxy (resource: POST /katello/api/capsules/:id/content/lifecycle_environments)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,7 +30,7 @@ parameters: id: type: number required: true - description: "Id of the capsule" + description: "Id of the smart proxy" environment_id: type: number required: true diff --git a/actions/capsules.capsule_content_apsules.yaml b/actions/capsules.capsule_content_apsules.yaml index 19a5412..6377c16 100644 --- a/actions/capsules.capsule_content_apsules.yaml +++ b/actions/capsules.capsule_content_apsules.yaml @@ -1,5 +1,5 @@ --- -description: "Remove lifecycle environments from the capsule (resource: DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id)" +description: "Remove lifecycle environments from the smart proxy (resource: DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,7 +30,7 @@ parameters: id: type: number required: true - description: "Id of the capsule" + description: "Id of the smart proxy" environment_id: type: number required: true diff --git a/actions/capsules.capsule_content_available_lifecycle_environments.yaml b/actions/capsules.capsule_content_available_lifecycle_environments.yaml index 6b84f29..bdcd751 100644 --- a/actions/capsules.capsule_content_available_lifecycle_environments.yaml +++ b/actions/capsules.capsule_content_available_lifecycle_environments.yaml @@ -1,5 +1,5 @@ --- -description: "List the lifecycle environments not attached to the capsule (resource: GET /katello/api/capsules/:id/content/available_lifecycle_environments)" +description: "List the lifecycle environments not attached to the smart proxy (resource: GET /katello/api/capsules/:id/content/available_lifecycle_environments)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,7 +30,7 @@ parameters: id: type: number required: true - description: "Id of the capsule" + description: "Id of the smart proxy" organization_id: type: number required: false diff --git a/actions/capsules.capsule_content_cancel_sync.yaml b/actions/capsules.capsule_content_cancel_sync.yaml index 94d8c82..5202c77 100644 --- a/actions/capsules.capsule_content_cancel_sync.yaml +++ b/actions/capsules.capsule_content_cancel_sync.yaml @@ -1,5 +1,5 @@ --- -description: "Cancel running capsule synchronization (resource: DELETE /katello/api/capsules/:id/content/sync)" +description: "Cancel running smart proxy synchronization (resource: DELETE /katello/api/capsules/:id/content/sync)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,4 +30,4 @@ parameters: id: type: number required: true - description: "Id of the capsule" \ No newline at end of file + description: "Id of the smart proxy" \ No newline at end of file diff --git a/actions/capsules.capsule_content_lifecycle_environments.yaml b/actions/capsules.capsule_content_lifecycle_environments.yaml index 62bc3b7..4128b6c 100644 --- a/actions/capsules.capsule_content_lifecycle_environments.yaml +++ b/actions/capsules.capsule_content_lifecycle_environments.yaml @@ -1,5 +1,5 @@ --- -description: "List the lifecycle environments attached to the capsule (resource: GET /katello/api/capsules/:id/content/lifecycle_environments)" +description: "List the lifecycle environments attached to the smart proxy (resource: GET /katello/api/capsules/:id/content/lifecycle_environments)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,7 +30,7 @@ parameters: id: type: number required: true - description: "Id of the capsule" + description: "Id of the smart proxy" organization_id: type: number required: false diff --git a/actions/capsules.capsule_content_sync.yaml b/actions/capsules.capsule_content_sync.yaml index 5e1a614..4691ba6 100644 --- a/actions/capsules.capsule_content_sync.yaml +++ b/actions/capsules.capsule_content_sync.yaml @@ -1,5 +1,5 @@ --- -description: "Synchronize the content to the capsule (resource: POST /katello/api/capsules/:id/content/sync)" +description: "Synchronize the content to the smart proxy (resource: POST /katello/api/capsules/:id/content/sync)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,7 +30,7 @@ parameters: id: type: number required: true - description: "Id of the capsule" + description: "Id of the smart proxy" environment_id: type: number required: false @@ -38,4 +38,4 @@ parameters: skip_metadata_check: type: boolean required: false - description: "Skip metadata check on each repository on the capsule" \ No newline at end of file + description: "Skip metadata check on each repository on the smart proxy" \ No newline at end of file diff --git a/actions/capsules.capsule_content_sync_status.yaml b/actions/capsules.capsule_content_sync_status.yaml index c62627c..f108c15 100644 --- a/actions/capsules.capsule_content_sync_status.yaml +++ b/actions/capsules.capsule_content_sync_status.yaml @@ -1,5 +1,5 @@ --- -description: "Get current capsule synchronization status (resource: GET /katello/api/capsules/:id/content/sync)" +description: "Get current smart proxy synchronization status (resource: GET /katello/api/capsules/:id/content/sync)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,7 +30,7 @@ parameters: id: type: number required: true - description: "Id of the capsule" + description: "Id of the smart proxy" organization_id: type: number required: false diff --git a/actions/capsules.index.yaml b/actions/capsules.index.yaml index 7d7b2c4..9aef781 100644 --- a/actions/capsules.index.yaml +++ b/actions/capsules.index.yaml @@ -1,5 +1,5 @@ --- -description: "List all capsules that have content (resource: GET /katello/api/capsules)" +description: "List all smart proxies that have content (resource: GET /katello/api/capsules)" enabled: true runner_type: "python-script" entry_point: lib/action.py diff --git a/actions/capsules.show.yaml b/actions/capsules.show.yaml index 5d29f5f..84325d2 100644 --- a/actions/capsules.show.yaml +++ b/actions/capsules.show.yaml @@ -1,5 +1,5 @@ --- -description: "Show the capsule details (resource: GET /katello/api/capsules/:id)" +description: "Show the smart proxy details (resource: GET /katello/api/capsules/:id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,4 +30,4 @@ parameters: id: type: number required: true - description: "Id of the capsule" \ No newline at end of file + description: "Id of the smart proxy" \ No newline at end of file diff --git a/actions/common_parameters.create.yaml b/actions/common_parameters.create.yaml index cc544f5..8ed58c6 100644 --- a/actions/common_parameters.create.yaml +++ b/actions/common_parameters.create.yaml @@ -30,27 +30,31 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" common_parameter: type: object required: true description: > "description: parameters: - hidden_value: - required: false - type: string - description: '' name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string + hidden_value: description: '' + required: false + type: string " \ No newline at end of file diff --git a/actions/common_parameters.destroy.yaml b/actions/common_parameters.destroy.yaml index 9899921..2fef4c1 100644 --- a/actions/common_parameters.destroy.yaml +++ b/actions/common_parameters.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/common_parameters.index.yaml b/actions/common_parameters.index.yaml index f12aa04..88257af 100644 --- a/actions/common_parameters.index.yaml +++ b/actions/common_parameters.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" show_hidden: type: boolean required: false @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/common_parameters.show.yaml b/actions/common_parameters.show.yaml index 691ecd7..4123de1 100644 --- a/actions/common_parameters.show.yaml +++ b/actions/common_parameters.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" show_hidden: type: boolean required: false diff --git a/actions/common_parameters.update.yaml b/actions/common_parameters.update.yaml index f3e5d99..df558c0 100644 --- a/actions/common_parameters.update.yaml +++ b/actions/common_parameters.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,16 +44,20 @@ parameters: description: > "description: parameters: - hidden_value: + name: + description: '' required: false type: string + value: description: '' - name: required: false type: string - description: '' - value: + parameter_type: + description: Type of value required: false type: string + hidden_value: description: '' + required: false + type: string " \ No newline at end of file diff --git a/actions/compute_attributes.create.yaml b/actions/compute_attributes.create.yaml index 98d1cc4..e4ec4c5 100644 --- a/actions/compute_attributes.create.yaml +++ b/actions/compute_attributes.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -48,7 +48,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: true type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_attributes.index.yaml b/actions/compute_attributes.index.yaml new file mode 100644 index 0000000..6173255 --- /dev/null +++ b/actions/compute_attributes.index.yaml @@ -0,0 +1,61 @@ +--- +description: "List of compute attributes (resource: GET /api/compute_attributes/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_attributes.index +pack: foreman +parameters: + operation: + type: string + default: compute_attributes.index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + compute_profile_id: + type: string + required: false + description: "ID of compute profile" + compute_resource_id: + type: string + required: false + description: "ID of compute_resource" + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_attributes.show.yaml b/actions/compute_attributes.show.yaml new file mode 100644 index 0000000..d27128a --- /dev/null +++ b/actions/compute_attributes.show.yaml @@ -0,0 +1,37 @@ +--- +description: "Show a compute attributes set (resource: GET /api/compute_attributes/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_attributes.show +pack: foreman +parameters: + operation: + type: string + default: compute_attributes.show + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/compute_attributes.update.yaml b/actions/compute_attributes.update.yaml index 19fe9e9..fd45da4 100644 --- a/actions/compute_attributes.update.yaml +++ b/actions/compute_attributes.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: false @@ -51,7 +51,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: false type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_createresources.yaml b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_createresources.yaml index 67eae4a..32c8ddc 100644 --- a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_createresources.yaml +++ b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_createresources.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -48,7 +48,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: true type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_indexresources.yaml b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_indexresources.yaml new file mode 100644 index 0000000..94c104d --- /dev/null +++ b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_indexresources.yaml @@ -0,0 +1,61 @@ +--- +description: "List of compute attributes for provided compute profile and compute resource (resource: GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_profiles.compute_attributes_compute_profile_id_compute_indexresources +pack: foreman +parameters: + operation: + type: string + default: compute_profiles.compute_attributes_compute_profile_id_compute_indexresources + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + compute_profile_id: + type: string + required: true + description: "ID of compute profile" + compute_resource_id: + type: string + required: true + description: "ID of compute_resource" + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_showattributes.yaml b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_showattributes.yaml new file mode 100644 index 0000000..ce9e37e --- /dev/null +++ b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_showattributes.yaml @@ -0,0 +1,37 @@ +--- +description: "Show a compute attributes set (resource: GET /api/compute_profiles/:compute_profile_id/compute_attributes/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_profiles.compute_attributes_compute_profile_id_compute_showattributes +pack: foreman +parameters: + operation: + type: string + default: compute_profiles.compute_attributes_compute_profile_id_compute_showattributes + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_showresources.yaml b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_showresources.yaml new file mode 100644 index 0000000..010d907 --- /dev/null +++ b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_showresources.yaml @@ -0,0 +1,37 @@ +--- +description: "Show a compute attributes set (resource: GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_profiles.compute_attributes_compute_profile_id_compute_showresources +pack: foreman +parameters: + operation: + type: string + default: compute_profiles.compute_attributes_compute_profile_id_compute_showresources + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateattributes.yaml b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateattributes.yaml index 9d6c1ca..6a8d970 100644 --- a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateattributes.yaml +++ b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateattributes.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -51,7 +51,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: false type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateresources.yaml b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateresources.yaml index 625e958..9e3ba66 100644 --- a/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateresources.yaml +++ b/actions/compute_profiles.compute_attributes_compute_profile_id_compute_updateresources.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -51,7 +51,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: false type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_create.yaml b/actions/compute_profiles.compute_attributes_create.yaml index 49f6870..84c2f2d 100644 --- a/actions/compute_profiles.compute_attributes_create.yaml +++ b/actions/compute_profiles.compute_attributes_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -48,7 +48,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: true type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_profiles.compute_attributes_index.yaml b/actions/compute_profiles.compute_attributes_index.yaml new file mode 100644 index 0000000..2293907 --- /dev/null +++ b/actions/compute_profiles.compute_attributes_index.yaml @@ -0,0 +1,61 @@ +--- +description: "List of compute attributes for compute profile (resource: GET /api/compute_profiles/:compute_profile_id/compute_attributes)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_profiles.compute_attributes_index +pack: foreman +parameters: + operation: + type: string + default: compute_profiles.compute_attributes_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + compute_profile_id: + type: string + required: true + description: "ID of compute profile" + compute_resource_id: + type: string + required: false + description: "ID of compute_resource" + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_profiles.create.yaml b/actions/compute_profiles.create.yaml index 29c7e04..ec2863f 100644 --- a/actions/compute_profiles.create.yaml +++ b/actions/compute_profiles.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile: type: object required: true @@ -42,7 +42,7 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/compute_profiles.destroy.yaml b/actions/compute_profiles.destroy.yaml index c71cdbc..69d3d99 100644 --- a/actions/compute_profiles.destroy.yaml +++ b/actions/compute_profiles.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_profiles.index.yaml b/actions/compute_profiles.index.yaml index 1a499c1..25cdce5 100644 --- a/actions/compute_profiles.index.yaml +++ b/actions/compute_profiles.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_profiles.show.yaml b/actions/compute_profiles.show.yaml index 40fa030..c12a55c 100644 --- a/actions/compute_profiles.show.yaml +++ b/actions/compute_profiles.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_profiles.update.yaml b/actions/compute_profiles.update.yaml index 837edd6..f322e03 100644 --- a/actions/compute_profiles.update.yaml +++ b/actions/compute_profiles.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/compute_resources.associate.yaml b/actions/compute_resources.associate.yaml index 988bc94..effc129 100644 --- a/actions/compute_resources.associate.yaml +++ b/actions/compute_resources.associate.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.available_clusters.yaml b/actions/compute_resources.available_clusters.yaml index 9d7dae0..e3e4cb3 100644 --- a/actions/compute_resources.available_clusters.yaml +++ b/actions/compute_resources.available_clusters.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.available_flavors.yaml b/actions/compute_resources.available_flavors.yaml index 7f759c5..156d3ce 100644 --- a/actions/compute_resources.available_flavors.yaml +++ b/actions/compute_resources.available_flavors.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.available_folders.yaml b/actions/compute_resources.available_folders.yaml index 8c6af22..8d1c4fd 100644 --- a/actions/compute_resources.available_folders.yaml +++ b/actions/compute_resources.available_folders.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.available_images.yaml b/actions/compute_resources.available_images.yaml index 5258975..5da69cd 100644 --- a/actions/compute_resources.available_images.yaml +++ b/actions/compute_resources.available_images.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.available_networks.yaml b/actions/compute_resources.available_networks.yaml index e5e13a3..eb146cc 100644 --- a/actions/compute_resources.available_networks.yaml +++ b/actions/compute_resources.available_networks.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/compute_resources.available_security_groups.yaml b/actions/compute_resources.available_security_groups.yaml index d4742cc..abe290c 100644 --- a/actions/compute_resources.available_security_groups.yaml +++ b/actions/compute_resources.available_security_groups.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.available_storage_domains.yaml b/actions/compute_resources.available_storage_domains.yaml index 2c63c38..d067395 100644 --- a/actions/compute_resources.available_storage_domains.yaml +++ b/actions/compute_resources.available_storage_domains.yaml @@ -30,14 +30,17 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true + cluster_id: + type: string + required: false storage_domain: type: string required: false \ No newline at end of file diff --git a/actions/compute_resources.available_storage_pods.yaml b/actions/compute_resources.available_storage_pods.yaml index 4c07d45..18dcf4c 100644 --- a/actions/compute_resources.available_storage_pods.yaml +++ b/actions/compute_resources.available_storage_pods.yaml @@ -30,14 +30,17 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true + cluster_id: + type: string + required: false storage_pod: type: string required: false \ No newline at end of file diff --git a/actions/compute_resources.available_zones.yaml b/actions/compute_resources.available_zones.yaml index 8472635..ca26a91 100644 --- a/actions/compute_resources.available_zones.yaml +++ b/actions/compute_resources.available_zones.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_compute_resource_id_compute_createprofiles.yaml b/actions/compute_resources.compute_attributes_compute_resource_id_compute_createprofiles.yaml index ad4db0d..6b13699 100644 --- a/actions/compute_resources.compute_attributes_compute_resource_id_compute_createprofiles.yaml +++ b/actions/compute_resources.compute_attributes_compute_resource_id_compute_createprofiles.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -48,7 +48,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: true type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_compute_resource_id_compute_indexprofiles.yaml b/actions/compute_resources.compute_attributes_compute_resource_id_compute_indexprofiles.yaml new file mode 100644 index 0000000..8f6b429 --- /dev/null +++ b/actions/compute_resources.compute_attributes_compute_resource_id_compute_indexprofiles.yaml @@ -0,0 +1,61 @@ +--- +description: "List of compute attributes for provided compute profile and compute resource (resource: GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.compute_attributes_compute_resource_id_compute_indexprofiles +pack: foreman +parameters: + operation: + type: string + default: compute_resources.compute_attributes_compute_resource_id_compute_indexprofiles + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + compute_profile_id: + type: string + required: true + description: "ID of compute profile" + compute_resource_id: + type: string + required: true + description: "ID of compute_resource" + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_compute_resource_id_compute_showattributes.yaml b/actions/compute_resources.compute_attributes_compute_resource_id_compute_showattributes.yaml new file mode 100644 index 0000000..f4a7e89 --- /dev/null +++ b/actions/compute_resources.compute_attributes_compute_resource_id_compute_showattributes.yaml @@ -0,0 +1,37 @@ +--- +description: "Show a compute attributes set (resource: GET /api/compute_resources/:compute_resource_id/compute_attributes/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.compute_attributes_compute_resource_id_compute_showattributes +pack: foreman +parameters: + operation: + type: string + default: compute_resources.compute_attributes_compute_resource_id_compute_showattributes + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_compute_resource_id_compute_showprofiles.yaml b/actions/compute_resources.compute_attributes_compute_resource_id_compute_showprofiles.yaml new file mode 100644 index 0000000..7a9f70b --- /dev/null +++ b/actions/compute_resources.compute_attributes_compute_resource_id_compute_showprofiles.yaml @@ -0,0 +1,37 @@ +--- +description: "Show a compute attributes set (resource: GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.compute_attributes_compute_resource_id_compute_showprofiles +pack: foreman +parameters: + operation: + type: string + default: compute_resources.compute_attributes_compute_resource_id_compute_showprofiles + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateattributes.yaml b/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateattributes.yaml index bd7c5c8..578fed3 100644 --- a/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateattributes.yaml +++ b/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateattributes.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: false @@ -51,7 +51,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: false type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateprofiles.yaml b/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateprofiles.yaml index f0a1e2d..2d22c8a 100644 --- a/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateprofiles.yaml +++ b/actions/compute_resources.compute_attributes_compute_resource_id_compute_updateprofiles.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -51,7 +51,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: false type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_create.yaml b/actions/compute_resources.compute_attributes_create.yaml index b7d0311..189b2bb 100644 --- a/actions/compute_resources.compute_attributes_create.yaml +++ b/actions/compute_resources.compute_attributes_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_profile_id: type: string required: true @@ -48,7 +48,7 @@ parameters: "description: parameters: vm_attrs: + description: '' required: true type: object - description: '' " \ No newline at end of file diff --git a/actions/compute_resources.compute_attributes_index.yaml b/actions/compute_resources.compute_attributes_index.yaml new file mode 100644 index 0000000..6e2d8b3 --- /dev/null +++ b/actions/compute_resources.compute_attributes_index.yaml @@ -0,0 +1,61 @@ +--- +description: "List of compute attributes for compute resource (resource: GET /api/compute_resources/:compute_resource_id/compute_attributes)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.compute_attributes_index +pack: foreman +parameters: + operation: + type: string + default: compute_resources.compute_attributes_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + compute_profile_id: + type: string + required: false + description: "ID of compute profile" + compute_resource_id: + type: string + required: true + description: "ID of compute_resource" + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_resources.create.yaml b/actions/compute_resources.create.yaml index 01cca52..bb65efe 100644 --- a/actions/compute_resources.create.yaml +++ b/actions/compute_resources.create.yaml @@ -30,91 +30,123 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource: type: object required: true description: > "description: parameters: - organization_ids: - required: false - type: array - description: REPLACE organizations with given ids. - datacenter: + name: + description: '' + required: true + type: string + provider: + description: Providers include EC2, Vmware, Docker required: false type: string - description: for RHEV, VMware Datacenter - domain: + url: + description: URL for Docker, Libvirt, oVirt, OpenStack and Rackspace required: false type: string - description: for RHEL OpenStack Platform only description: + description: '' required: false type: string - description: '' - set_console_password: + user: + description: Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2. required: false - type: boolean - description: for Libvirt and VMware only - caching_enabled: + type: string + password: + description: Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2 + required: false + type: string + uuid: + description: Deprecated, please use datacenter + required: false + type: string + datacenter: + description: for oVirt, VMware Datacenter + required: false + type: string + use_v4: + description: for oVirt only required: false type: boolean - description: enable caching, for VMware only - url: + ovirt_quota: + description: for oVirt only, ID of quota to use + required: false + type: string + public_key: + description: for oVirt only required: false type: string - description: URL for Docker, Libvirt, RHEV, RHEL OpenStack Platform and Rackspace region: + description: for AzureRm eg. 'eastus' and for EC2 only. Use'us-gov-west-1' for EC2 GovCloud region required: false type: string - description: for EC2 only, use 'us-gov-west-1' for GovCloud region - uuid: + tenant: + description: for OpenStack and AzureRm only required: false type: string - description: Deprecated, please use datacenter - server: + domain: + description: for OpenStack (v3) only + required: false + type: string + project_domain_name: + description: for OpenStack (v3) only + required: false + type: string + project_domain_id: + description: for OpenStack (v3) only required: false type: string + server: description: for VMware - ovirt_quota: required: false type: string - description: for RHEV only, ID of quota to use - use_v4: + set_console_password: + description: for Libvirt and VMware only required: false type: boolean - description: for RHEV only - user: + display_type: + description: for Libvirt and oVirt only required: false type: string - description: Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key forEC2. - provider: + keyboard: + description: for oVirt only required: false type: string - description: Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE,Docker - display_type: + caching_enabled: + description: enable caching, for VMware only + required: false + type: boolean + project: + description: Project id for GCE only required: false type: string - description: for Libvirt only - password: + email: + description: Email for GCE only + required: false + type: string + key_path: + description: Certificate path for GCE only + required: false + type: string + zone: + description: for GCE only required: false type: string - description: Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids - tenant: + organization_ids: + description: REPLACE organizations with given ids. required: false - type: string - description: for RHEL OpenStack Platform only - name: - required: true - type: string - description: '' + type: array " \ No newline at end of file diff --git a/actions/compute_resources.destroy.yaml b/actions/compute_resources.destroy.yaml index 27a74e4..2467b68 100644 --- a/actions/compute_resources.destroy.yaml +++ b/actions/compute_resources.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.id_available_available_networksclusters.yaml b/actions/compute_resources.id_available_available_networksclusters.yaml index 06f2bc6..277c6dd 100644 --- a/actions/compute_resources.id_available_available_networksclusters.yaml +++ b/actions/compute_resources.id_available_available_networksclusters.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/compute_resources.id_available_available_resource_poolsclusters.yaml b/actions/compute_resources.id_available_available_resource_poolsclusters.yaml index 1eb1196..d116b33 100644 --- a/actions/compute_resources.id_available_available_resource_poolsclusters.yaml +++ b/actions/compute_resources.id_available_available_resource_poolsclusters.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/compute_resources.id_available_available_storage_domainsclusters.yaml b/actions/compute_resources.id_available_available_storage_domainsclusters.yaml new file mode 100644 index 0000000..bfe8b52 --- /dev/null +++ b/actions/compute_resources.id_available_available_storage_domainsclusters.yaml @@ -0,0 +1,46 @@ +--- +description: "List storage domains for a compute resource (resource: GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.id_available_available_storage_domainsclusters +pack: foreman +parameters: + operation: + type: string + default: compute_resources.id_available_available_storage_domainsclusters + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + cluster_id: + type: string + required: true + storage_domain: + type: string + required: false \ No newline at end of file diff --git a/actions/compute_resources.id_available_available_storage_podsclusters.yaml b/actions/compute_resources.id_available_available_storage_podsclusters.yaml new file mode 100644 index 0000000..9a2068c --- /dev/null +++ b/actions/compute_resources.id_available_available_storage_podsclusters.yaml @@ -0,0 +1,46 @@ +--- +description: "List storage pods for a compute resource (resource: GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.id_available_available_storage_podsclusters +pack: foreman +parameters: + operation: + type: string + default: compute_resources.id_available_available_storage_podsclusters + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + cluster_id: + type: string + required: true + storage_pod: + type: string + required: false \ No newline at end of file diff --git a/actions/compute_resources.id_available_storage_available_storage_domainsdomains.yaml b/actions/compute_resources.id_available_storage_available_storage_domainsdomains.yaml index 36350ad..1d53f8a 100644 --- a/actions/compute_resources.id_available_storage_available_storage_domainsdomains.yaml +++ b/actions/compute_resources.id_available_storage_available_storage_domainsdomains.yaml @@ -30,14 +30,17 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true + cluster_id: + type: string + required: false storage_domain: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.id_available_storage_available_storage_podspods.yaml b/actions/compute_resources.id_available_storage_available_storage_podspods.yaml index 75785df..e72f7ef 100644 --- a/actions/compute_resources.id_available_storage_available_storage_podspods.yaml +++ b/actions/compute_resources.id_available_storage_available_storage_podspods.yaml @@ -30,14 +30,17 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true + cluster_id: + type: string + required: false storage_pod: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.id_storage_storage_domaindomains.yaml b/actions/compute_resources.id_storage_storage_domaindomains.yaml new file mode 100644 index 0000000..c6cbdd5 --- /dev/null +++ b/actions/compute_resources.id_storage_storage_domaindomains.yaml @@ -0,0 +1,43 @@ +--- +description: "List attributes for a given storage domain (resource: GET /api/compute_resources/:id/storage_domains/:storage_domain_id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.id_storage_storage_domaindomains +pack: foreman +parameters: + operation: + type: string + default: compute_resources.id_storage_storage_domaindomains + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + storage_domain_id: + type: string + required: true \ No newline at end of file diff --git a/actions/compute_resources.id_storage_storage_podpods.yaml b/actions/compute_resources.id_storage_storage_podpods.yaml new file mode 100644 index 0000000..a28a9fe --- /dev/null +++ b/actions/compute_resources.id_storage_storage_podpods.yaml @@ -0,0 +1,43 @@ +--- +description: "List attributes for a given storage pod (resource: GET /api/compute_resources/:id/storage_pods/:storage_pod_id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: compute_resources.id_storage_storage_podpods +pack: foreman +parameters: + operation: + type: string + default: compute_resources.id_storage_storage_podpods + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + storage_pod_id: + type: string + required: true \ No newline at end of file diff --git a/actions/compute_resources.images_compute_resource_id_destroyimages.yaml b/actions/compute_resources.images_compute_resource_id_destroyimages.yaml index 7c15aaf..aa86bda 100644 --- a/actions/compute_resources.images_compute_resource_id_destroyimages.yaml +++ b/actions/compute_resources.images_compute_resource_id_destroyimages.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource_id: type: string required: true diff --git a/actions/compute_resources.images_compute_resource_id_showimages.yaml b/actions/compute_resources.images_compute_resource_id_showimages.yaml index 21fc0ff..fd77a14 100644 --- a/actions/compute_resources.images_compute_resource_id_showimages.yaml +++ b/actions/compute_resources.images_compute_resource_id_showimages.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/compute_resources.images_compute_resource_id_updateimages.yaml b/actions/compute_resources.images_compute_resource_id_updateimages.yaml index 2acb235..111edb9 100644 --- a/actions/compute_resources.images_compute_resource_id_updateimages.yaml +++ b/actions/compute_resources.images_compute_resource_id_updateimages.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource_id: type: string required: true @@ -47,36 +47,36 @@ parameters: description: > "description: parameters: - username: - required: false - type: string + name: description: '' - operatingsystem_id: required: false type: string - description: ID of operating system - compute_resource_id: + username: + description: '' required: false type: string - description: ID of compute resource uuid: + description: Template ID in the compute resource required: false type: string + password: description: '' - user_data: required: false - type: boolean - description: Whether or not the image supports user data - architecture_id: + type: string + compute_resource_id: + description: ID of compute resource required: false type: string + architecture_id: description: ID of architecture - password: required: false type: string - description: '' - name: + operatingsystem_id: + description: ID of operating system required: false type: string - description: '' + user_data: + description: Whether or not the image supports user data + required: false + type: boolean " \ No newline at end of file diff --git a/actions/compute_resources.images_create.yaml b/actions/compute_resources.images_create.yaml index f68f2ee..c78a8f4 100644 --- a/actions/compute_resources.images_create.yaml +++ b/actions/compute_resources.images_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource_id: type: string required: true @@ -44,36 +44,36 @@ parameters: description: > "description: parameters: - username: + name: + description: '' required: true type: string + username: description: '' - operatingsystem_id: - required: false - type: string - description: ID of operating system - compute_resource_id: - required: false + required: true type: string - description: ID of compute resource uuid: + description: Template ID in the compute resource required: true type: string + password: description: '' - user_data: required: false - type: boolean - description: Whether or not the image supports user data - architecture_id: + type: string + compute_resource_id: + description: ID of compute resource required: false type: string + architecture_id: description: ID of architecture - password: required: false type: string - description: '' - name: - required: true + operatingsystem_id: + description: ID of operating system + required: false type: string - description: '' + user_data: + description: Whether or not the image supports user data + required: false + type: boolean " \ No newline at end of file diff --git a/actions/compute_resources.images_index.yaml b/actions/compute_resources.images_index.yaml index 6f0d858..065e9d5 100644 --- a/actions/compute_resources.images_index.yaml +++ b/actions/compute_resources.images_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource_id: type: string required: true @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_resources.index.yaml b/actions/compute_resources.index.yaml index 8823289..b7a7cea 100644 --- a/actions/compute_resources.index.yaml +++ b/actions/compute_resources.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/compute_resources.refresh_cache.yaml b/actions/compute_resources.refresh_cache.yaml index 020aec4..64953b0 100644 --- a/actions/compute_resources.refresh_cache.yaml +++ b/actions/compute_resources.refresh_cache.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.show.yaml b/actions/compute_resources.show.yaml index f69378f..05c3dd0 100644 --- a/actions/compute_resources.show.yaml +++ b/actions/compute_resources.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/compute_resources.update.yaml b/actions/compute_resources.update.yaml index e581c94..16d29ce 100644 --- a/actions/compute_resources.update.yaml +++ b/actions/compute_resources.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,80 +44,112 @@ parameters: description: > "description: parameters: - organization_ids: + name: + description: '' required: false - type: array - description: REPLACE organizations with given ids. - datacenter: + type: string + provider: + description: Providers include EC2, Vmware, Docker required: false type: string - description: for RHEV, VMware Datacenter - domain: + url: + description: URL for Docker, Libvirt, oVirt, OpenStack and Rackspace required: false type: string - description: for RHEL OpenStack Platform only description: + description: '' required: false type: string - description: '' - set_console_password: + user: + description: Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2. required: false - type: boolean - description: for Libvirt and VMware only - caching_enabled: + type: string + password: + description: Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2 + required: false + type: string + uuid: + description: Deprecated, please use datacenter + required: false + type: string + datacenter: + description: for oVirt, VMware Datacenter + required: false + type: string + use_v4: + description: for oVirt only required: false type: boolean - description: enable caching, for VMware only - url: + ovirt_quota: + description: for oVirt only, ID of quota to use + required: false + type: string + public_key: + description: for oVirt only required: false type: string - description: URL for Docker, Libvirt, RHEV, RHEL OpenStack Platform and Rackspace region: + description: for AzureRm eg. 'eastus' and for EC2 only. Use'us-gov-west-1' for EC2 GovCloud region required: false type: string - description: for EC2 only, use 'us-gov-west-1' for GovCloud region - uuid: + tenant: + description: for OpenStack and AzureRm only required: false type: string - description: Deprecated, please use datacenter - server: + domain: + description: for OpenStack (v3) only + required: false + type: string + project_domain_name: + description: for OpenStack (v3) only required: false type: string + project_domain_id: + description: for OpenStack (v3) only + required: false + type: string + server: description: for VMware - ovirt_quota: required: false type: string - description: for RHEV only, ID of quota to use - use_v4: + set_console_password: + description: for Libvirt and VMware only required: false type: boolean - description: for RHEV only - user: + display_type: + description: for Libvirt and oVirt only required: false type: string - description: Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key forEC2. - provider: + keyboard: + description: for oVirt only required: false type: string - description: Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE,Docker - display_type: + caching_enabled: + description: enable caching, for VMware only required: false - type: string - description: for Libvirt only - password: + type: boolean + project: + description: Project id for GCE only required: false type: string - description: Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 - location_ids: + email: + description: Email for GCE only required: false - type: array - description: REPLACE locations with given ids - tenant: + type: string + key_path: + description: Certificate path for GCE only required: false type: string - description: for RHEL OpenStack Platform only - name: + zone: + description: for GCE only required: false type: string - description: '' + location_ids: + description: REPLACE locations with given ids + required: false + type: array + organization_ids: + description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/config_groups.create.yaml b/actions/config_groups.create.yaml index e779fe3..e6c270b 100644 --- a/actions/config_groups.create.yaml +++ b/actions/config_groups.create.yaml @@ -30,23 +30,23 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_group: type: object required: true description: > "description: parameters: - puppetclass_ids: - required: false - type: array - description: '' name: + description: '' required: true type: string + puppetclass_ids: description: '' + required: false + type: array " \ No newline at end of file diff --git a/actions/config_groups.destroy.yaml b/actions/config_groups.destroy.yaml index 67633c6..e16dbd5 100644 --- a/actions/config_groups.destroy.yaml +++ b/actions/config_groups.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/config_groups.index.yaml b/actions/config_groups.index.yaml index a1a058c..71f412d 100644 --- a/actions/config_groups.index.yaml +++ b/actions/config_groups.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/config_groups.show.yaml b/actions/config_groups.show.yaml index cd9fddd..97f5d7f 100644 --- a/actions/config_groups.show.yaml +++ b/actions/config_groups.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/config_groups.update.yaml b/actions/config_groups.update.yaml index 3008c49..dbc27eb 100644 --- a/actions/config_groups.update.yaml +++ b/actions/config_groups.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,12 +44,12 @@ parameters: description: > "description: parameters: - puppetclass_ids: - required: false - type: array - description: '' name: + description: '' required: false type: string + puppetclass_ids: description: '' + required: false + type: array " \ No newline at end of file diff --git a/actions/config_reports.create.yaml b/actions/config_reports.create.yaml index e2aa6bb..e8884d2 100644 --- a/actions/config_reports.create.yaml +++ b/actions/config_reports.create.yaml @@ -30,35 +30,35 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_report: type: object required: true description: > "description: parameters: - reported_at: + host: + description: Hostname or certname required: true type: string + reported_at: description: UTC time of report - status: required: true - type: object + type: string + status: description: Hash of status type totals - host: required: true - type: string - description: Hostname or certname + type: object metrics: + description: Hash of report metrics, can be just {} required: true type: object - description: Hash of report metrics, can be just {} logs: + description: Optional array of log hashes required: false type: array - description: Optional array of log hashes " \ No newline at end of file diff --git a/actions/config_reports.destroy.yaml b/actions/config_reports.destroy.yaml index cfac48b..1426ca2 100644 --- a/actions/config_reports.destroy.yaml +++ b/actions/config_reports.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/config_reports.index.yaml b/actions/config_reports.index.yaml index b84b6c9..780d7a7 100644 --- a/actions/config_reports.index.yaml +++ b/actions/config_reports.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/config_reports.show.yaml b/actions/config_reports.show.yaml index 6738056..b7142dc 100644 --- a/actions/config_reports.show.yaml +++ b/actions/config_reports.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/config_templates.build_pxe_default.yaml b/actions/config_templates.build_pxe_default.yaml index 06bbde8..647be79 100644 --- a/actions/config_templates.build_pxe_default.yaml +++ b/actions/config_templates.build_pxe_default.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/config_templates.clone.yaml b/actions/config_templates.clone.yaml index 4e417de..c3f0d06 100644 --- a/actions/config_templates.clone.yaml +++ b/actions/config_templates.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: template name required: true type: string - description: template name " \ No newline at end of file diff --git a/actions/config_templates.create.yaml b/actions/config_templates.create.yaml index 2fd6d31..63de96a 100644 --- a/actions/config_templates.create.yaml +++ b/actions/config_templates.create.yaml @@ -30,55 +30,59 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template: type: object required: true description: > "description: parameters: - operatingsystem_ids: - required: false - type: array - description: Array of operating system IDs to associate with the template - template_combinations_attributes: - required: false - type: array - description: Array of template combinations (hostgroup_id, environment_id) - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: template name required: true type: string - description: template name - snippet: - required: false - type: boolean + description: description: '' - template_kind_id: required: false - type: number - description: not relevant for snippet + type: string template: + description: '' required: true type: string + snippet: description: '' + required: false + type: boolean audit_comment: + description: '' required: false type: string - description: '' - location_ids: + template_kind_id: + description: not relevant for snippet + required: false + type: number + template_combinations_attributes: + description: Array of template combinations (hostgroup_id, environment_id) required: false type: array + operatingsystem_ids: + description: Array of operating system IDs to associate with the template + required: false + type: array + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean + location_ids: description: REPLACE locations with given ids - organization_ids: required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/config_templates.destroy.yaml b/actions/config_templates.destroy.yaml index eded169..37fe732 100644 --- a/actions/config_templates.destroy.yaml +++ b/actions/config_templates.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/config_templates.index.yaml b/actions/config_templates.index.yaml index f53973b..73cccd1 100644 --- a/actions/config_templates.index.yaml +++ b/actions/config_templates.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/config_templates.operatingsystems_index.yaml b/actions/config_templates.operatingsystems_index.yaml index de2e55f..125e80c 100644 --- a/actions/config_templates.operatingsystems_index.yaml +++ b/actions/config_templates.operatingsystems_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture_id: type: string required: false @@ -62,13 +62,13 @@ parameters: "description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value " search: type: string @@ -77,12 +77,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/config_templates.os_default_templates_index.yaml b/actions/config_templates.os_default_templates_index.yaml index da9790b..8100f47 100644 --- a/actions/config_templates.os_default_templates_index.yaml +++ b/actions/config_templates.os_default_templates_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: false @@ -48,10 +48,10 @@ parameters: required: false description: "ID of provisioning template" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/config_templates.revision.yaml b/actions/config_templates.revision.yaml index 1fdf5b5..f4a65b5 100644 --- a/actions/config_templates.revision.yaml +++ b/actions/config_templates.revision.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" version: type: string required: false diff --git a/actions/config_templates.show.yaml b/actions/config_templates.show.yaml index 2673d03..5a5b4e9 100644 --- a/actions/config_templates.show.yaml +++ b/actions/config_templates.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/config_templates.template_combinations_config_template_id_template_showcombinations.yaml b/actions/config_templates.template_combinations_config_template_id_template_showcombinations.yaml index 7d15b5d..6cd3ad7 100644 --- a/actions/config_templates.template_combinations_config_template_id_template_showcombinations.yaml +++ b/actions/config_templates.template_combinations_config_template_id_template_showcombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: true diff --git a/actions/config_templates.template_combinations_config_template_id_template_updatecombinations.yaml b/actions/config_templates.template_combinations_config_template_id_template_updatecombinations.yaml index a5d5366..ad9d66e 100644 --- a/actions/config_templates.template_combinations_config_template_id_template_updatecombinations.yaml +++ b/actions/config_templates.template_combinations_config_template_id_template_updatecombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -61,11 +61,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/config_templates.template_combinations_create.yaml b/actions/config_templates.template_combinations_create.yaml index 4a143d3..1141965 100644 --- a/actions/config_templates.template_combinations_create.yaml +++ b/actions/config_templates.template_combinations_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: true @@ -58,11 +58,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/config_templates.template_combinations_index.yaml b/actions/config_templates.template_combinations_index.yaml index e684293..8c7898f 100644 --- a/actions/config_templates.template_combinations_index.yaml +++ b/actions/config_templates.template_combinations_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: true diff --git a/actions/config_templates.update.yaml b/actions/config_templates.update.yaml index af4ab16..e80ace0 100644 --- a/actions/config_templates.update.yaml +++ b/actions/config_templates.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,44 +44,48 @@ parameters: description: > "description: parameters: - operatingsystem_ids: - required: false - type: array - description: Array of operating system IDs to associate with the template - template_combinations_attributes: + name: + description: template name required: false - type: array - description: Array of template combinations (hostgroup_id, environment_id) - locked: + type: string + description: + description: '' required: false - type: boolean - description: Whether or not the template is locked for editing - name: + type: string + template: + description: '' required: false type: string - description: template name snippet: + description: '' required: false type: boolean + audit_comment: description: '' + required: false + type: string template_kind_id: + description: not relevant for snippet required: false type: number - description: not relevant for snippet - template: + template_combinations_attributes: + description: Array of template combinations (hostgroup_id, environment_id) required: false - type: string - description: '' - audit_comment: + type: array + operatingsystem_ids: + description: Array of operating system IDs to associate with the template required: false - type: string - description: '' + type: array + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/content_view_filters.ansible_collections_index.yaml b/actions/content_view_filters.ansible_collections_index.yaml new file mode 100644 index 0000000..56685d2 --- /dev/null +++ b/actions/content_view_filters.ansible_collections_index.yaml @@ -0,0 +1,85 @@ +--- +description: "List ansible_collections (resource: GET /katello/api/content_view_filters/:content_view_filter_id/ansible_collections)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: content_view_filters.ansible_collections_index +pack: foreman +parameters: + operation: + type: string + default: content_view_filters.ansible_collections_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + organization_id: + type: number + required: false + description: "organization identifier" + content_view_version_id: + type: number + required: false + description: "content view version identifier" + content_view_filter_id: + type: number + required: true + description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" + repository_id: + type: number + required: false + description: "repository identifier" + environment_id: + type: number + required: false + description: "environment identifier" + ids: + type: array + required: false + description: "ids to filter content by" + search: + type: string + required: false + description: "Search string" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" + order: + type: string + required: false + description: "Sort field and order, eg. 'id DESC'" + full_result: + type: boolean + required: false + description: "Whether or not to show all results" + sort_by: + type: string + required: false + description: "Field to sort the results on" + sort_order: + type: string + required: false + description: "How to order the sorted results (e.g. ASC for ascending)" \ No newline at end of file diff --git a/actions/content_view_filters.content_view_filter_rules_create.yaml b/actions/content_view_filters.content_view_filter_rules_create.yaml index c7bd932..2bb6148 100644 --- a/actions/content_view_filters.content_view_filter_rules_create.yaml +++ b/actions/content_view_filters.content_view_filter_rules_create.yaml @@ -78,4 +78,8 @@ parameters: date_type: type: string required: false - description: "erratum: search using the 'Issued On' or 'Updated On'column of the errata. Values are 'issued'/'updated'" \ No newline at end of file + description: "erratum: search using the 'Issued On' or 'Updated On'column of the errata. Values are 'issued'/'updated'" + module_stream_ids: + type: array + required: false + description: "module stream ids" \ No newline at end of file diff --git a/actions/content_view_filters.create.yaml b/actions/content_view_filters.create.yaml index daf2af5..da11916 100644 --- a/actions/content_view_filters.create.yaml +++ b/actions/content_view_filters.create.yaml @@ -38,7 +38,7 @@ parameters: type: type: string required: true - description: "type of filter (e.g. rpm, package_group, erratum, docker)" + description: "type of filter (e.g. rpm, package_group, erratum, docker, modulemd)" original_packages: type: boolean required: false diff --git a/actions/content_view_filters.debs_index.yaml b/actions/content_view_filters.debs_index.yaml index 6070121..1ef3000 100644 --- a/actions/content_view_filters.debs_index.yaml +++ b/actions/content_view_filters.debs_index.yaml @@ -1,5 +1,5 @@ --- -description: "List debs (resource: GET /katello/api/content_view_filters/:content_view_filter_id/debs)" +description: "List deb packages (resource: GET /katello/api/content_view_filters/:content_view_filter_id/debs)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,27 +30,47 @@ parameters: organization_id: type: number required: false - description: "organization identifier" + description: "Organization identifier" content_view_version_id: type: number required: false - description: "content view version identifier" + description: "Content View Version identifier" content_view_filter_id: type: number required: true - description: "content view filter identifier" + description: "Content View Filter identifier" repository_id: type: number required: false - description: "repository identifier" + description: "Repository identifier" environment_id: type: number required: false - description: "environment identifier" + description: "Environment identifier" ids: type: array required: false - description: "ids to filter content by" + description: "Deb package identifiers to filter content by" + host_id: + type: number + required: false + description: "Host id to list applicable deb packages for" + packages_restrict_applicable: + type: boolean + required: false + description: "Return deb packages that are applicable to one or more hosts (defaults totrue if host_id is specified)" + packages_restrict_upgradable: + type: boolean + required: false + description: "Return deb packages that are upgradable on one or more hosts" + packages_restrict_latest: + type: boolean + required: false + description: "Return only the latest version of each package" + available_for: + type: string + required: false + description: "Return deb packages that can be added to the specified object. Only thevalue 'content_view_version' is supported." search: type: string required: false diff --git a/actions/content_view_filters.docker_manifest_lists_index.yaml b/actions/content_view_filters.docker_manifest_lists_index.yaml index fedfa37..3b89245 100644 --- a/actions/content_view_filters.docker_manifest_lists_index.yaml +++ b/actions/content_view_filters.docker_manifest_lists_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.docker_manifests_index.yaml b/actions/content_view_filters.docker_manifests_index.yaml index eb0a4e2..14abcd7 100644 --- a/actions/content_view_filters.docker_manifests_index.yaml +++ b/actions/content_view_filters.docker_manifests_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.docker_tags_index.yaml b/actions/content_view_filters.docker_tags_index.yaml index fd800c9..b619de0 100644 --- a/actions/content_view_filters.docker_tags_index.yaml +++ b/actions/content_view_filters.docker_tags_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.file_units_index.yaml b/actions/content_view_filters.file_units_index.yaml index f13a790..88fbe3a 100644 --- a/actions/content_view_filters.file_units_index.yaml +++ b/actions/content_view_filters.file_units_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.module_streams_index.yaml b/actions/content_view_filters.module_streams_index.yaml index 7800b87..a8557da 100644 --- a/actions/content_view_filters.module_streams_index.yaml +++ b/actions/content_view_filters.module_streams_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.ostree_branches_index.yaml b/actions/content_view_filters.ostree_branches_index.yaml index 3fac410..f03bbca 100644 --- a/actions/content_view_filters.ostree_branches_index.yaml +++ b/actions/content_view_filters.ostree_branches_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.package_groups_index.yaml b/actions/content_view_filters.package_groups_index.yaml index ee562a3..bf55d86 100644 --- a/actions/content_view_filters.package_groups_index.yaml +++ b/actions/content_view_filters.package_groups_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.puppet_modules_index.yaml b/actions/content_view_filters.puppet_modules_index.yaml index 557bb43..c5aee21 100644 --- a/actions/content_view_filters.puppet_modules_index.yaml +++ b/actions/content_view_filters.puppet_modules_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: true description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_view_filters.update.yaml b/actions/content_view_filters.update.yaml index 3a5f36a..31ac389 100644 --- a/actions/content_view_filters.update.yaml +++ b/actions/content_view_filters.update.yaml @@ -50,4 +50,8 @@ parameters: repository_ids: type: array required: false - description: "list of repository ids" \ No newline at end of file + description: "list of repository ids" + description: + type: string + required: false + description: "description of the filter" \ No newline at end of file diff --git a/actions/content_view_versions.incremental_update.yaml b/actions/content_view_versions.incremental_update.yaml index 36b8802..7514b56 100644 --- a/actions/content_view_versions.incremental_update.yaml +++ b/actions/content_view_versions.incremental_update.yaml @@ -34,13 +34,13 @@ parameters: "description: parameters: content_view_version_id: + description: Content View Version Ids to perform an incremental update on. May containcomposites as well as one or more components to update. required: false type: number - description: Content View Version Ids to perform an incremental update on. May containcomposites as well as one or more components to update. environment_ids: + description: The list of environments to promote the specified Content View Version to(replacing the older version) required: false type: array - description: The list of environments to promote the specified Content View Version to(replacing the older version) " description: type: string @@ -49,7 +49,7 @@ parameters: resolve_dependencies: type: boolean required: false - description: "If true, when adding the specified errata or packages, any neededdependencies will be copied as well" + description: "If true, when adding the specified errata or packages, any neededdependencies will be copied as well. Defaults to true" propagate_all_composites: type: boolean required: false @@ -60,22 +60,22 @@ parameters: description: > "description: parameters: - package_ids: + errata_ids: + description: Errata ids to copy into the new versions required: false type: array - description: Package ids or uuids to copy into the new versions - deb_ids: + package_ids: + description: Package ids to copy into the new versions required: false type: array - description: Deb Package ids or uuids to copy into the new versions - errata_ids: + deb_ids: + description: Deb Package ids to copy into the new versions required: false type: array - description: Errata ids or uuids to copy into the new versions puppet_module_ids: + description: Puppet Module ids to copy into the new versions required: false type: array - description: Puppet Module ids or uuids to copy into the new versions " update_hosts: type: object @@ -84,25 +84,25 @@ parameters: "description: After generating the incremental update, apply the changes to the specifiedhosts. Only Errata are supported currently. parameters: included: + description: '' required: true type: object - description: '' parameters: search: + description: Search string for host to perform an action on required: false type: string - description: Search string for host to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on excluded: + description: '' required: false type: object - description: '' parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " \ No newline at end of file diff --git a/actions/content_views.ansible_collections_ontent_indexviews.yaml b/actions/content_views.ansible_collections_ontent_indexviews.yaml new file mode 100644 index 0000000..4b98a65 --- /dev/null +++ b/actions/content_views.ansible_collections_ontent_indexviews.yaml @@ -0,0 +1,85 @@ +--- +description: "List ansible_collections (resource: GET /katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: content_views.ansible_collections_ontent_indexviews +pack: foreman +parameters: + operation: + type: string + default: content_views.ansible_collections_ontent_indexviews + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + organization_id: + type: number + required: false + description: "organization identifier" + content_view_version_id: + type: number + required: false + description: "content view version identifier" + content_view_filter_id: + type: number + required: false + description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" + repository_id: + type: number + required: false + description: "repository identifier" + environment_id: + type: number + required: false + description: "environment identifier" + ids: + type: array + required: false + description: "ids to filter content by" + search: + type: string + required: false + description: "Search string" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" + order: + type: string + required: false + description: "Sort field and order, eg. 'id DESC'" + full_result: + type: boolean + required: false + description: "Whether or not to show all results" + sort_by: + type: string + required: false + description: "Field to sort the results on" + sort_order: + type: string + required: false + description: "How to order the sorted results (e.g. ASC for ascending)" \ No newline at end of file diff --git a/actions/content_views.content_view_components_add_components.yaml b/actions/content_views.content_view_components_add_components.yaml index 2a0c006..50a0ab3 100644 --- a/actions/content_views.content_view_components_add_components.yaml +++ b/actions/content_views.content_view_components_add_components.yaml @@ -37,16 +37,16 @@ parameters: description: > "description: Array of components to add parameters: - content_view_id: + content_view_version_id: + description: identifier of the version of the component content view required: false type: number + content_view_id: description: content view identifier of the component who's latest version isdesired - content_view_version_id: required: false type: number - description: identifier of the version of the component content view latest: + description: true if the latest version of the component's content view is desired required: false type: boolean - description: true if the latest version of the component's content view is desired " \ No newline at end of file diff --git a/actions/content_views.content_view_filters_create.yaml b/actions/content_views.content_view_filters_create.yaml index 415adb4..5c4e79c 100644 --- a/actions/content_views.content_view_filters_create.yaml +++ b/actions/content_views.content_view_filters_create.yaml @@ -38,7 +38,7 @@ parameters: type: type: string required: true - description: "type of filter (e.g. rpm, package_group, erratum, docker)" + description: "type of filter (e.g. rpm, package_group, erratum, docker, modulemd)" original_packages: type: boolean required: false diff --git a/actions/content_views.content_view_filters_ontent_updateviews.yaml b/actions/content_views.content_view_filters_ontent_updateviews.yaml index 9affdcb..9af236e 100644 --- a/actions/content_views.content_view_filters_ontent_updateviews.yaml +++ b/actions/content_views.content_view_filters_ontent_updateviews.yaml @@ -50,4 +50,8 @@ parameters: repository_ids: type: array required: false - description: "list of repository ids" \ No newline at end of file + description: "list of repository ids" + description: + type: string + required: false + description: "description of the filter" \ No newline at end of file diff --git a/actions/content_views.content_view_puppet_modules_index.yaml b/actions/content_views.content_view_puppet_modules_index.yaml index 778ced3..f0a48a1 100644 --- a/actions/content_views.content_view_puppet_modules_index.yaml +++ b/actions/content_views.content_view_puppet_modules_index.yaml @@ -42,7 +42,7 @@ parameters: uuid: type: string required: false - description: "the uuid of the puppet module to associate" + description: "uuid of the puppet module" search: type: string required: false diff --git a/actions/content_views.create.yaml b/actions/content_views.create.yaml index 831a322..d265c1a 100644 --- a/actions/content_views.create.yaml +++ b/actions/content_views.create.yaml @@ -58,4 +58,8 @@ parameters: auto_publish: type: boolean required: false - description: "Enable/Disable auto publish of composite view" \ No newline at end of file + description: "Enable/Disable auto publish of composite view" + solve_dependencies: + type: boolean + required: false + description: "Solve RPM dependencies by default on Content View publish, defaults tofalse" \ No newline at end of file diff --git a/actions/content_views.debs_ontent_indexviews.yaml b/actions/content_views.debs_ontent_indexviews.yaml index 3760cc8..feea56b 100644 --- a/actions/content_views.debs_ontent_indexviews.yaml +++ b/actions/content_views.debs_ontent_indexviews.yaml @@ -1,5 +1,5 @@ --- -description: "List debs (resource: GET /katello/api/content_views/:content_view_id/filters/:filter_id/debs)" +description: "List deb packages (resource: GET /katello/api/content_views/:content_view_id/filters/:filter_id/debs)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,27 +30,47 @@ parameters: organization_id: type: number required: false - description: "organization identifier" + description: "Organization identifier" content_view_version_id: type: number required: false - description: "content view version identifier" + description: "Content View Version identifier" content_view_filter_id: type: number required: false - description: "content view filter identifier" + description: "Content View Filter identifier" repository_id: type: number required: false - description: "repository identifier" + description: "Repository identifier" environment_id: type: number required: false - description: "environment identifier" + description: "Environment identifier" ids: type: array required: false - description: "ids to filter content by" + description: "Deb package identifiers to filter content by" + host_id: + type: number + required: false + description: "Host id to list applicable deb packages for" + packages_restrict_applicable: + type: boolean + required: false + description: "Return deb packages that are applicable to one or more hosts (defaults totrue if host_id is specified)" + packages_restrict_upgradable: + type: boolean + required: false + description: "Return deb packages that are upgradable on one or more hosts" + packages_restrict_latest: + type: boolean + required: false + description: "Return only the latest version of each package" + available_for: + type: string + required: false + description: "Return deb packages that can be added to the specified object. Only thevalue 'content_view_version' is supported." search: type: string required: false diff --git a/actions/content_views.docker_manifest_lists_ontent_indexviews.yaml b/actions/content_views.docker_manifest_lists_ontent_indexviews.yaml index 5d7cb92..f457887 100644 --- a/actions/content_views.docker_manifest_lists_ontent_indexviews.yaml +++ b/actions/content_views.docker_manifest_lists_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.docker_manifests_ontent_indexviews.yaml b/actions/content_views.docker_manifests_ontent_indexviews.yaml index 7d5d1a6..b2b3fc0 100644 --- a/actions/content_views.docker_manifests_ontent_indexviews.yaml +++ b/actions/content_views.docker_manifests_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.docker_tags_ontent_indexviews.yaml b/actions/content_views.docker_tags_ontent_indexviews.yaml index 4bfb80c..dc32064 100644 --- a/actions/content_views.docker_tags_ontent_indexviews.yaml +++ b/actions/content_views.docker_tags_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.file_units_ontent_indexviews.yaml b/actions/content_views.file_units_ontent_indexviews.yaml index 0805ea2..bf2bdee 100644 --- a/actions/content_views.file_units_ontent_indexviews.yaml +++ b/actions/content_views.file_units_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.module_streams_ontent_indexviews.yaml b/actions/content_views.module_streams_ontent_indexviews.yaml index dbddf17..95fca23 100644 --- a/actions/content_views.module_streams_ontent_indexviews.yaml +++ b/actions/content_views.module_streams_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.ostree_branches_ontent_indexviews.yaml b/actions/content_views.ostree_branches_ontent_indexviews.yaml index c85d5a0..c9d1897 100644 --- a/actions/content_views.ostree_branches_ontent_indexviews.yaml +++ b/actions/content_views.ostree_branches_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.package_groups_ontent_indexviews.yaml b/actions/content_views.package_groups_ontent_indexviews.yaml index 9ef4976..db25f18 100644 --- a/actions/content_views.package_groups_ontent_indexviews.yaml +++ b/actions/content_views.package_groups_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.publish.yaml b/actions/content_views.publish.yaml index 2f69452..7fd759b 100644 --- a/actions/content_views.publish.yaml +++ b/actions/content_views.publish.yaml @@ -49,12 +49,12 @@ parameters: description: > "description: Specify the list of units in each repo parameters: - rpm_filenames: - required: true - type: array - description: list of rpm filename strings to include in published version label: + description: repo label required: true type: string - description: repo label + rpm_filenames: + description: list of rpm filename strings to include in published version + required: true + type: array " \ No newline at end of file diff --git a/actions/content_views.puppet_modules_ontent_indexviews.yaml b/actions/content_views.puppet_modules_ontent_indexviews.yaml index 6955e01..9e7cc6e 100644 --- a/actions/content_views.puppet_modules_ontent_indexviews.yaml +++ b/actions/content_views.puppet_modules_ontent_indexviews.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/content_views.repositories_index.yaml b/actions/content_views.repositories_index.yaml index 79c5e06..3133bba 100644 --- a/actions/content_views.repositories_index.yaml +++ b/actions/content_views.repositories_index.yaml @@ -63,6 +63,10 @@ parameters: type: string required: false description: "Id of a file to find repositories that contain the file" + ansible_collection_id: + type: string + required: false + description: "Id of an ansible collection to find repositories that contain the ansiblecollection" ostree_branch_id: type: string required: false @@ -71,6 +75,10 @@ parameters: type: boolean required: false description: "show repositories in Library and the default content view" + archived: + type: boolean + required: false + description: "show archived repositories" content_type: type: string required: false @@ -91,6 +99,10 @@ parameters: type: string required: false description: "interpret specified object to return only Repositories that can beassociated with specified object. Only 'content_view' &'content_view_version' are supported." + with_content: + type: string + required: false + description: "only repositories having at least one of the specified content type ex: rpm, erratum" search: type: string required: false diff --git a/actions/content_views.update.yaml b/actions/content_views.update.yaml index cc7d2b0..72fd344 100644 --- a/actions/content_views.update.yaml +++ b/actions/content_views.update.yaml @@ -50,4 +50,8 @@ parameters: auto_publish: type: boolean required: false - description: "Enable/Disable auto publish of composite view" \ No newline at end of file + description: "Enable/Disable auto publish of composite view" + solve_dependencies: + type: boolean + required: false + description: "Solve RPM dependencies by default on Content View publish, defaults tofalse" \ No newline at end of file diff --git a/actions/current_user.users_show_current.yaml b/actions/current_user.users_show_current.yaml new file mode 100644 index 0000000..16106f3 --- /dev/null +++ b/actions/current_user.users_show_current.yaml @@ -0,0 +1,37 @@ +--- +description: "Show the currently logged-in user (resource: GET /api/current_user)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: current_user.users_show_current +pack: foreman +parameters: + operation: + type: string + default: current_user.users_show_current + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/dashboard.index.yaml b/actions/dashboard.index.yaml index 88fb432..b97ce9c 100644 --- a/actions/dashboard.index.yaml +++ b/actions/dashboard.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false diff --git a/actions/debs.compare.yaml b/actions/debs.compare.yaml index 2ebde3f..61ab1b2 100644 --- a/actions/debs.compare.yaml +++ b/actions/debs.compare.yaml @@ -1,5 +1,5 @@ --- -description: "List debs (resource: GET /katello/api/debs/compare)" +description: "List deb packages (resource: GET /katello/api/debs/compare)" enabled: true runner_type: "python-script" entry_point: lib/action.py diff --git a/actions/debs.index.yaml b/actions/debs.index.yaml index 9818c6c..bcc14d0 100644 --- a/actions/debs.index.yaml +++ b/actions/debs.index.yaml @@ -1,5 +1,5 @@ --- -description: "List debs (resource: GET /katello/api/debs)" +description: "List deb packages (resource: GET /katello/api/debs)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,27 +30,47 @@ parameters: organization_id: type: number required: false - description: "organization identifier" + description: "Organization identifier" content_view_version_id: type: number required: false - description: "content view version identifier" + description: "Content View Version identifier" content_view_filter_id: type: number required: false - description: "content view filter identifier" + description: "Content View Filter identifier" repository_id: type: number required: false - description: "repository identifier" + description: "Repository identifier" environment_id: type: number required: false - description: "environment identifier" + description: "Environment identifier" ids: type: array required: false - description: "ids to filter content by" + description: "Deb package identifiers to filter content by" + host_id: + type: number + required: false + description: "Host id to list applicable deb packages for" + packages_restrict_applicable: + type: boolean + required: false + description: "Return deb packages that are applicable to one or more hosts (defaults totrue if host_id is specified)" + packages_restrict_upgradable: + type: boolean + required: false + description: "Return deb packages that are upgradable on one or more hosts" + packages_restrict_latest: + type: boolean + required: false + description: "Return only the latest version of each package" + available_for: + type: string + required: false + description: "Return deb packages that can be added to the specified object. Only thevalue 'content_view_version' is supported." search: type: string required: false diff --git a/actions/debs.show.yaml b/actions/debs.show.yaml index 62b2dd4..c7fc22c 100644 --- a/actions/debs.show.yaml +++ b/actions/debs.show.yaml @@ -1,5 +1,5 @@ --- -description: "Show a deb (resource: GET /katello/api/debs/:id)" +description: "Show a deb package (resource: GET /katello/api/debs/:id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -34,4 +34,4 @@ parameters: id: type: string required: true - description: "a deb identifier" \ No newline at end of file + description: "a deb package identifier" \ No newline at end of file diff --git a/actions/discovered_hosts.auto_provision.yaml b/actions/discovered_hosts.auto_provision.yaml index e39b488..c26831e 100644 --- a/actions/discovered_hosts.auto_provision.yaml +++ b/actions/discovered_hosts.auto_provision.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovered_hosts.auto_provision_all.yaml b/actions/discovered_hosts.auto_provision_all.yaml index a371fdc..e36e35f 100644 --- a/actions/discovered_hosts.auto_provision_all.yaml +++ b/actions/discovered_hosts.auto_provision_all.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/discovered_hosts.create.yaml b/actions/discovered_hosts.create.yaml index 75495d8..4ca7099 100644 --- a/actions/discovered_hosts.create.yaml +++ b/actions/discovered_hosts.create.yaml @@ -30,31 +30,31 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" discovered_host: type: object required: false description: > "description: parameters: - ip: + name: + description: '' required: true type: string + ip: description: '' - mac: required: true type: string + mac: description: '' - pxe_loader: - required: false + required: true type: string + pxe_loader: description: DHCP filename option (Grub2 or PXELinux by default) - name: - required: true + required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/discovered_hosts.destroy.yaml b/actions/discovered_hosts.destroy.yaml index 803983f..7222ffb 100644 --- a/actions/discovered_hosts.destroy.yaml +++ b/actions/discovered_hosts.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovered_hosts.facts.yaml b/actions/discovered_hosts.facts.yaml index c0251d6..2cc2774 100644 --- a/actions/discovered_hosts.facts.yaml +++ b/actions/discovered_hosts.facts.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" facts: type: object required: true diff --git a/actions/discovered_hosts.index.yaml b/actions/discovered_hosts.index.yaml index 0272f55..a4765e2 100644 --- a/actions/discovered_hosts.index.yaml +++ b/actions/discovered_hosts.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false diff --git a/actions/discovered_hosts.reboot.yaml b/actions/discovered_hosts.reboot.yaml index 2b384b5..b3bd2f8 100644 --- a/actions/discovered_hosts.reboot.yaml +++ b/actions/discovered_hosts.reboot.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovered_hosts.reboot_all.yaml b/actions/discovered_hosts.reboot_all.yaml index 46746a5..c84d86d 100644 --- a/actions/discovered_hosts.reboot_all.yaml +++ b/actions/discovered_hosts.reboot_all.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/discovered_hosts.refresh_facts.yaml b/actions/discovered_hosts.refresh_facts.yaml index 6b5bd7d..f2d848b 100644 --- a/actions/discovered_hosts.refresh_facts.yaml +++ b/actions/discovered_hosts.refresh_facts.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovered_hosts.show.yaml b/actions/discovered_hosts.show.yaml index c5cf60a..1f63ca1 100644 --- a/actions/discovered_hosts.show.yaml +++ b/actions/discovered_hosts.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovered_hosts.update.yaml b/actions/discovered_hosts.update.yaml index 394f551..373a98a 100644 --- a/actions/discovered_hosts.update.yaml +++ b/actions/discovered_hosts.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,112 +44,112 @@ parameters: description: > "description: parameters: - environment_id: - required: false - type: string + name: description: '' - managed: required: false - type: boolean + type: string + environment_id: description: '' - model_id: required: false - type: number - description: '' + type: string ip: + description: not required if using a subnet with DHCP proxy required: false type: string - description: not required if using a subnet with DHCP Capsule - provision_method: + mac: + description: not required if it's a virtual machine required: false type: string + architecture_id: description: '' - domain_id: required: false type: number + domain_id: description: '' - ptable_id: required: false type: number + puppet_proxy_id: description: '' - subnet_id: required: false type: number + puppet_class_ids: description: '' - capabilities: - required: false - type: string - description: '' - architecture_id: required: false - type: number + type: array + operatingsystem_id: description: '' - build: required: false - type: boolean + type: string + medium_id: description: '' - host_parameters_attributes: required: false - type: array + type: number + ptable_id: description: '' - owner_id: required: false type: number + subnet_id: description: '' - operatingsystem_id: required: false - type: string - description: '' + type: number sp_subnet_id: + description: '' required: false type: number + model_id: description: '' - root_pass: - required: false - type: string - description: required if value is not inherited from host group or default password insettings - progress_report_id: - required: false - type: string - description: UUID to track orchestration tasks status, GET/api/orchestration/:UUID/tasks - image_id: required: false type: number + hostgroup_id: description: '' - mac: - required: false - type: string - description: not required if it's a virtual machine - puppet_ca_proxy_id: required: false type: number + owner_id: description: '' - puppet_proxy_id: required: false type: number + puppet_ca_proxy_id: description: '' - name: required: false - type: string + type: number + image_id: description: '' - medium_id: required: false type: number + host_parameters_attributes: description: '' - puppet_class_ids: required: false type: array + build: description: '' + required: false + type: boolean enabled: + description: '' required: false type: boolean + provision_method: description: '' - hostgroup_id: required: false - type: number + type: string + managed: description: '' - pxe_loader: + required: false + type: boolean + progress_report_id: + description: UUID to track orchestration tasks status, GET/api/orchestration/:UUID/tasks + required: false + type: string + capabilities: + description: '' + required: false + type: string + root_pass: + description: required if value is not inherited from host group or default password insettings required: false type: string + pxe_loader: description: DHCP filename option (Grub2 or PXELinux by default) + required: false + type: string " \ No newline at end of file diff --git a/actions/discovery_rules.create.yaml b/actions/discovery_rules.create.yaml index a9b4e3a..083af95 100644 --- a/actions/discovery_rules.create.yaml +++ b/actions/discovery_rules.create.yaml @@ -30,51 +30,51 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" discovery_rule: type: object required: false description: > "description: parameters: - search: + name: + description: represents rule name shown to the users required: true type: string + search: description: query to match discovered hosts for the particular rule - name: required: true type: string - description: represents rule name shown to the users - hostname: - required: false - type: string - description: defines a pattern to assign human-readable hostnames to the matching hosts - enabled: - required: false - type: boolean - description: flag is used for temporary shutdown of rules hostgroup_id: + description: the hostgroup that is used to auto provision a host required: true type: number - description: the hostgroup that is used to auto provision a host + hostname: + description: defines a pattern to assign human-readable hostnames to the matching hosts + required: false + type: string max_count: + description: enables to limit maximum amount of provisioned hosts per rule required: false type: number - description: enables to limit maximum amount of provisioned hosts per rule priority: + description: puts the rules in order, low numbers go first. Must be greater then zero required: false type: number - description: puts the rules in order, low numbers go first. Must be greater then zero + enabled: + description: flag is used for temporary shutdown of rules + required: false + type: boolean location_ids: + description: location ID for provisioned hosts required: true type: array - description: location ID for provisioned hosts organization_ids: + description: organization ID for provisioned hosts required: true type: array - description: organization ID for provisioned hosts " \ No newline at end of file diff --git a/actions/discovery_rules.destroy.yaml b/actions/discovery_rules.destroy.yaml index b7d9ec3..9fde6ca 100644 --- a/actions/discovery_rules.destroy.yaml +++ b/actions/discovery_rules.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovery_rules.index.yaml b/actions/discovery_rules.index.yaml index 5817cbb..e187cd4 100644 --- a/actions/discovery_rules.index.yaml +++ b/actions/discovery_rules.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false diff --git a/actions/discovery_rules.show.yaml b/actions/discovery_rules.show.yaml index a06b721..5f366b7 100644 --- a/actions/discovery_rules.show.yaml +++ b/actions/discovery_rules.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/discovery_rules.update.yaml b/actions/discovery_rules.update.yaml index 9a73086..49f1100 100644 --- a/actions/discovery_rules.update.yaml +++ b/actions/discovery_rules.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,40 +44,40 @@ parameters: description: > "description: parameters: - search: - required: false - type: string - description: query to match discovered hosts for the particular rule name: - required: false - type: string description: represents rule name shown to the users - hostname: required: false type: string - description: defines a pattern to assign human-readable hostnames to the matching hosts - enabled: + search: + description: query to match discovered hosts for the particular rule required: false - type: boolean - description: flag is used for temporary shutdown of rules + type: string hostgroup_id: + description: the hostgroup that is used to auto provision a host required: false type: number - description: the hostgroup that is used to auto provision a host + hostname: + description: defines a pattern to assign human-readable hostnames to the matching hosts + required: false + type: string max_count: + description: enables to limit maximum amount of provisioned hosts per rule required: false type: number - description: enables to limit maximum amount of provisioned hosts per rule priority: + description: puts the rules in order, low numbers go first. Must be greater then zero required: false type: number - description: puts the rules in order, low numbers go first. Must be greater then zero + enabled: + description: flag is used for temporary shutdown of rules + required: false + type: boolean location_ids: + description: location ID for provisioned hosts required: false type: array - description: location ID for provisioned hosts organization_ids: + description: organization ID for provisioned hosts required: false type: array - description: organization ID for provisioned hosts " \ No newline at end of file diff --git a/actions/docker_manifest_lists.index.yaml b/actions/docker_manifest_lists.index.yaml index cefdc31..14106ca 100644 --- a/actions/docker_manifest_lists.index.yaml +++ b/actions/docker_manifest_lists.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/docker_manifests.index.yaml b/actions/docker_manifests.index.yaml index fcda670..779fd97 100644 --- a/actions/docker_manifests.index.yaml +++ b/actions/docker_manifests.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/docker_tags.index.yaml b/actions/docker_tags.index.yaml index 8e6aa8c..ee4ce24 100644 --- a/actions/docker_tags.index.yaml +++ b/actions/docker_tags.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/domains.create.yaml b/actions/domains.create.yaml index 2e2b511..1ca6842 100644 --- a/actions/domains.create.yaml +++ b/actions/domains.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" domain: type: object required: true @@ -42,27 +42,27 @@ parameters: "description: parameters: name: + description: The full DNS domain name required: true type: string - description: The full DNS domain name - domain_parameters_attributes: + fullname: + description: Description of the domain required: false - type: array - description: Array of parameters (name, value) + type: string dns_id: + description: DNS proxy ID to use within this domain required: false type: number - description: DNS Capsule ID to use within this domain - fullname: + domain_parameters_attributes: + description: Array of parameters (name, value) required: false - type: string - description: Description of the domain + type: array location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/domains.destroy.yaml b/actions/domains.destroy.yaml index a7fcd3b..742033a 100644 --- a/actions/domains.destroy.yaml +++ b/actions/domains.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/domains.index.yaml b/actions/domains.index.yaml index 564eeb4..b9def45 100644 --- a/actions/domains.index.yaml +++ b/actions/domains.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/domains.interfaces_index.yaml b/actions/domains.interfaces_index.yaml index f41af17..2fceb0e 100644 --- a/actions/domains.interfaces_index.yaml +++ b/actions/domains.interfaces_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -48,10 +48,10 @@ parameters: required: false description: "ID or name of subnet" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/domains.parameters_create.yaml b/actions/domains.parameters_create.yaml index cf7e186..66d7940 100644 --- a/actions/domains.parameters_create.yaml +++ b/actions/domains.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/domains.parameters_domain_id_updateparameters.yaml b/actions/domains.parameters_domain_id_updateparameters.yaml index 765a8f6..811be1d 100644 --- a/actions/domains.parameters_domain_id_updateparameters.yaml +++ b/actions/domains.parameters_domain_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/domains.parameters_index.yaml b/actions/domains.parameters_index.yaml index 3a70cd5..f898da7 100644 --- a/actions/domains.parameters_index.yaml +++ b/actions/domains.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/domains.show.yaml b/actions/domains.show.yaml index fc10f7a..085031a 100644 --- a/actions/domains.show.yaml +++ b/actions/domains.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/domains.subnets_index.yaml b/actions/domains.subnets_index.yaml index 47ba73a..656dd1d 100644 --- a/actions/domains.subnets_index.yaml +++ b/actions/domains.subnets_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/domains.update.yaml b/actions/domains.update.yaml index 7c53d61..5b74259 100644 --- a/actions/domains.update.yaml +++ b/actions/domains.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,27 +45,27 @@ parameters: "description: parameters: name: + description: The full DNS domain name required: false type: string - description: The full DNS domain name - domain_parameters_attributes: + fullname: + description: Description of the domain required: false - type: array - description: Array of parameters (name, value) + type: string dns_id: + description: DNS proxy ID to use within this domain required: false type: number - description: DNS Capsule ID to use within this domain - fullname: + domain_parameters_attributes: + description: Array of parameters (name, value) required: false - type: string - description: Description of the domain + type: array location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/environments.create.yaml b/actions/environments.create.yaml index 1fb3513..df4a965 100644 --- a/actions/environments.create.yaml +++ b/actions/environments.create.yaml @@ -30,27 +30,27 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" environment: type: object required: true description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: '' required: true type: string - description: '' - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/environments.destroy.yaml b/actions/environments.destroy.yaml index 565b7cb..18ecf0c 100644 --- a/actions/environments.destroy.yaml +++ b/actions/environments.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/environments.environment_id_smart_import_puppetclassesproxies.yaml b/actions/environments.environment_id_smart_import_puppetclassesproxies.yaml index 9638395..2e53229 100644 --- a/actions/environments.environment_id_smart_import_puppetclassesproxies.yaml +++ b/actions/environments.environment_id_smart_import_puppetclassesproxies.yaml @@ -1,5 +1,5 @@ --- -description: "Import puppet classes from puppet Capsule for an environment (resource: POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses)" +description: "Import puppet classes from puppet proxy for an environment (resource: POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/environments.hosts_index.yaml b/actions/environments.hosts_index.yaml index dc1b3e0..6b13024 100644 --- a/actions/environments.hosts_index.yaml +++ b/actions/environments.hosts_index.yaml @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/environments.index.yaml b/actions/environments.index.yaml index 9eab7f2..7b6f069 100644 --- a/actions/environments.index.yaml +++ b/actions/environments.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/environments.puppetclasses_environment_id_showpuppetclasses.yaml b/actions/environments.puppetclasses_environment_id_showpuppetclasses.yaml index 4e3cb3d..8ac3104 100644 --- a/actions/environments.puppetclasses_environment_id_showpuppetclasses.yaml +++ b/actions/environments.puppetclasses_environment_id_showpuppetclasses.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false diff --git a/actions/environments.puppetclasses_index.yaml b/actions/environments.puppetclasses_index.yaml index 65ff3a0..85a6303 100644 --- a/actions/environments.puppetclasses_index.yaml +++ b/actions/environments.puppetclasses_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/environments.repositories_nvironments.yaml b/actions/environments.repositories_nvironments.yaml index 738f1b3..759dc27 100644 --- a/actions/environments.repositories_nvironments.yaml +++ b/actions/environments.repositories_nvironments.yaml @@ -63,6 +63,10 @@ parameters: type: string required: false description: "Id of a file to find repositories that contain the file" + ansible_collection_id: + type: string + required: false + description: "Id of an ansible collection to find repositories that contain the ansiblecollection" ostree_branch_id: type: string required: false @@ -71,6 +75,10 @@ parameters: type: boolean required: false description: "show repositories in Library and the default content view" + archived: + type: boolean + required: false + description: "show archived repositories" content_type: type: string required: false @@ -91,6 +99,10 @@ parameters: type: string required: false description: "interpret specified object to return only Repositories that can beassociated with specified object. Only 'content_view' &'content_view_version' are supported." + with_content: + type: string + required: false + description: "only repositories having at least one of the specified content type ex: rpm, erratum" search: type: string required: false diff --git a/actions/environments.show.yaml b/actions/environments.show.yaml index c7e280c..21a6e80 100644 --- a/actions/environments.show.yaml +++ b/actions/environments.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/environments.smart_class_parameters_environment_id_indexpuppetclasses.yaml b/actions/environments.smart_class_parameters_environment_id_indexpuppetclasses.yaml index 78c6aaf..51c9a54 100644 --- a/actions/environments.smart_class_parameters_environment_id_indexpuppetclasses.yaml +++ b/actions/environments.smart_class_parameters_environment_id_indexpuppetclasses.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/environments.smart_class_parameters_index.yaml b/actions/environments.smart_class_parameters_index.yaml index f4383af..938b220 100644 --- a/actions/environments.smart_class_parameters_index.yaml +++ b/actions/environments.smart_class_parameters_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/environments.smart_proxies_environment_id_smart_import_puppetclassesproxies.yaml b/actions/environments.smart_proxies_environment_id_smart_import_puppetclassesproxies.yaml index e5ed231..961949d 100644 --- a/actions/environments.smart_proxies_environment_id_smart_import_puppetclassesproxies.yaml +++ b/actions/environments.smart_proxies_environment_id_smart_import_puppetclassesproxies.yaml @@ -1,5 +1,5 @@ --- -description: "Import puppet classes from puppet Capsule for an environment (resource: POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses)" +description: "Import puppet classes from puppet proxy for an environment (resource: POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/environments.template_combinations_create.yaml b/actions/environments.template_combinations_create.yaml index 442b1ed..2e7adcf 100644 --- a/actions/environments.template_combinations_create.yaml +++ b/actions/environments.template_combinations_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false @@ -58,11 +58,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/environments.template_combinations_environment_id_template_showcombinations.yaml b/actions/environments.template_combinations_environment_id_template_showcombinations.yaml index 5fac616..0c75a5e 100644 --- a/actions/environments.template_combinations_environment_id_template_showcombinations.yaml +++ b/actions/environments.template_combinations_environment_id_template_showcombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/environments.template_combinations_environment_id_template_updatecombinations.yaml b/actions/environments.template_combinations_environment_id_template_updatecombinations.yaml index d4a442a..4bb9aba 100644 --- a/actions/environments.template_combinations_environment_id_template_updatecombinations.yaml +++ b/actions/environments.template_combinations_environment_id_template_updatecombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -61,11 +61,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/environments.template_combinations_index.yaml b/actions/environments.template_combinations_index.yaml index 855a768..91830ca 100644 --- a/actions/environments.template_combinations_index.yaml +++ b/actions/environments.template_combinations_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/environments.update.yaml b/actions/environments.update.yaml index eacfbf2..366dd27 100644 --- a/actions/environments.update.yaml +++ b/actions/environments.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,16 +44,16 @@ parameters: description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: '' required: false type: string - description: '' - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/fact_values.index.yaml b/actions/fact_values.index.yaml index 02787a6..ef40d8a 100644 --- a/actions/fact_values.index.yaml +++ b/actions/fact_values.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/files.file_units_compare.yaml b/actions/files.file_units_compare.yaml index 1fb2554..68e6be3 100644 --- a/actions/files.file_units_compare.yaml +++ b/actions/files.file_units_compare.yaml @@ -1,5 +1,5 @@ --- -description: "List files (resource: GET /katello/api/files/compare)" +description: "List :resource (resource: GET /katello/api/files/compare)" enabled: true runner_type: "python-script" entry_point: lib/action.py diff --git a/actions/files.file_units_index.yaml b/actions/files.file_units_index.yaml index 5dc8d7b..31a6a32 100644 --- a/actions/files.file_units_index.yaml +++ b/actions/files.file_units_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/filters.create.yaml b/actions/filters.create.yaml index e1a9ee3..042a3b3 100644 --- a/actions/filters.create.yaml +++ b/actions/filters.create.yaml @@ -30,39 +30,39 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" filter: type: object required: true description: > "description: parameters: - search: - required: false - type: string - description: '' - permission_ids: - required: false - type: array - description: '' role_id: + description: '' required: true type: string + search: description: '' + required: false + type: string override: + description: '' required: false type: boolean + permission_ids: description: '' - location_ids: required: false type: array - description: '' organization_ids: + description: '' required: false type: array + location_ids: description: '' + required: false + type: array " \ No newline at end of file diff --git a/actions/filters.destroy.yaml b/actions/filters.destroy.yaml index 629a8a6..fccdc17 100644 --- a/actions/filters.destroy.yaml +++ b/actions/filters.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/filters.index.yaml b/actions/filters.index.yaml index babe428..5aa45ab 100644 --- a/actions/filters.index.yaml +++ b/actions/filters.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/filters.show.yaml b/actions/filters.show.yaml index 96d1826..2140dea 100644 --- a/actions/filters.show.yaml +++ b/actions/filters.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/filters.update.yaml b/actions/filters.update.yaml index b4daf94..34b7849 100644 --- a/actions/filters.update.yaml +++ b/actions/filters.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,28 +44,28 @@ parameters: description: > "description: parameters: - search: - required: false - type: string + role_id: description: '' - permission_ids: required: false - type: array + type: string + search: description: '' - role_id: required: false type: string - description: '' override: + description: '' required: false type: boolean + permission_ids: description: '' - location_ids: required: false type: array - description: '' organization_ids: + description: '' required: false type: array + location_ids: description: '' + required: false + type: array " \ No newline at end of file diff --git a/actions/hostgroups.ansible_roles.yaml b/actions/hostgroups.ansible_roles.yaml index 6b5a4c5..c57ec9f 100644 --- a/actions/hostgroups.ansible_roles.yaml +++ b/actions/hostgroups.ansible_roles.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hostgroups.assign_ansible_roles.yaml b/actions/hostgroups.assign_ansible_roles.yaml new file mode 100644 index 0000000..5468559 --- /dev/null +++ b/actions/hostgroups.assign_ansible_roles.yaml @@ -0,0 +1,44 @@ +--- +description: "Assigns Ansible roles to a hostgroup (resource: POST /api/hostgroups/:id/assign_ansible_roles)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hostgroups.assign_ansible_roles +pack: foreman +parameters: + operation: + type: string + default: hostgroups.assign_ansible_roles + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + ansible_role_ids: + type: array + required: true + description: "Ansible roles to assign to a hostgroup" \ No newline at end of file diff --git a/actions/hostgroups.clone.yaml b/actions/hostgroups.clone.yaml index 9877b52..789a7e8 100644 --- a/actions/hostgroups.clone.yaml +++ b/actions/hostgroups.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" name: type: string required: true \ No newline at end of file diff --git a/actions/hostgroups.create.yaml b/actions/hostgroups.create.yaml index f07efa1..7d2fab7 100644 --- a/actions/hostgroups.create.yaml +++ b/actions/hostgroups.create.yaml @@ -30,132 +30,140 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" hostgroup: type: object required: true description: > "description: parameters: - config_group_ids: + name: + description: Name of the host group + required: true + type: string + description: + description: Host group description required: false - type: array - description: IDs of associated config groups - content_source_id: + type: string + parent_id: + description: Parent ID of the host group required: false type: number - description: Content source ID environment_id: + description: Environment ID required: false type: number - description: Environment ID - kickstart_repository_id: + compute_profile_id: + description: Compute profile ID required: false type: number - description: Kickstart repository ID - group_parameters_attributes: + compute_resource_id: + description: Compute resource ID required: false - type: array - description: Array of parameters - parameters: - name: - required: true - type: string - description: Name of the parameter - value: - required: true - type: string - description: Parameter value - openscap_proxy_id: + type: number + operatingsystem_id: + description: Operating system ID required: false type: number - description: ID of OpenSCAP Capsule - domain_id: + architecture_id: + description: Architecture ID required: false type: number - description: Domain ID - compute_resource_id: + pxe_loader: + description: DHCP filename option (Grub2/PXELinux by default) + required: false + type: string + medium_id: + description: Media ID required: false type: number - description: Compute resource ID - subnet_id: + ptable_id: + description: Partition table ID required: false type: number + subnet_id: description: Subnet ID - parent_id: required: false type: number - description: Parent ID of the host group - architecture_id: + subnet6_id: + description: Subnet IPv6 ID required: false type: number - description: Architecture ID - organization_ids: - required: false - type: array - description: REPLACE organizations with given ids. - operatingsystem_id: + domain_id: + description: Domain ID required: false type: number - description: Operating system ID - root_pass: + realm_id: + description: Realm ID required: false - type: string - description: Root password on provisioned hosts - ansible_role_ids: + type: number + config_group_ids: + description: IDs of associated config groups required: false type: array - description: IDs of associated ansible roles - description: + group_parameters_attributes: + description: Array of parameters required: false - type: string - description: Host group description - content_view_id: + type: array + parameters: + name: + description: Name of the parameter + required: true + type: string + value: + description: Parameter value + required: true + type: string + parameter_type: + description: Type of value + required: false + type: string + hidden_value: + description: '' + required: false + type: boolean + puppet_proxy_id: + description: Puppet proxy ID required: false type: number - description: Content view ID puppet_ca_proxy_id: + description: Puppet CA proxy ID required: false type: number - description: Puppet CA Capsule ID - puppet_proxy_id: + root_pass: + description: Root password on provisioned hosts required: false - type: number - description: Puppet Capsule ID - ptable_id: + type: string + location_ids: + description: REPLACE locations with given ids required: false - type: number - description: Partition table ID - pxe_loader: + type: array + organization_ids: + description: REPLACE organizations with given ids. required: false - type: string - description: DHCP filename option (Grub2/PXELinux by default) - name: - required: true - type: string - description: Name of the host group - medium_id: + type: array + content_source_id: + description: Content source ID required: false type: number - description: Media ID - lifecycle_environment_id: + content_view_id: + description: Content view ID required: false type: number + lifecycle_environment_id: description: Lifecycle environment ID - location_ids: - required: false - type: array - description: REPLACE locations with given ids - realm_id: required: false type: number - description: Realm ID - compute_profile_id: + kickstart_repository_id: + description: Kickstart repository ID required: false type: number - description: Compute profile ID + ansible_role_ids: + description: IDs of associated ansible roles + required: false + type: array " \ No newline at end of file diff --git a/actions/hostgroups.destroy.yaml b/actions/hostgroups.destroy.yaml index 167e046..933aa72 100644 --- a/actions/hostgroups.destroy.yaml +++ b/actions/hostgroups.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hostgroups.hostgroup_classes_create.yaml b/actions/hostgroups.hostgroup_classes_create.yaml index 6b95af3..cf55999 100644 --- a/actions/hostgroups.hostgroup_classes_create.yaml +++ b/actions/hostgroups.hostgroup_classes_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" hostgroup_id: type: string required: true diff --git a/actions/hostgroups.hostgroup_classes_hostgroup_id_puppetclass_destroyids.yaml b/actions/hostgroups.hostgroup_classes_hostgroup_id_puppetclass_destroyids.yaml index c81b006..8aee12d 100644 --- a/actions/hostgroups.hostgroup_classes_hostgroup_id_puppetclass_destroyids.yaml +++ b/actions/hostgroups.hostgroup_classes_hostgroup_id_puppetclass_destroyids.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" hostgroup_id: type: string required: true diff --git a/actions/hostgroups.hostgroup_classes_index.yaml b/actions/hostgroups.hostgroup_classes_index.yaml index 94dfaba..c958d3d 100644 --- a/actions/hostgroups.hostgroup_classes_index.yaml +++ b/actions/hostgroups.hostgroup_classes_index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/hostgroups.hosts_index.yaml b/actions/hostgroups.hosts_index.yaml index cbc55b4..2822359 100644 --- a/actions/hostgroups.hosts_index.yaml +++ b/actions/hostgroups.hosts_index.yaml @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hostgroups.index.yaml b/actions/hostgroups.index.yaml index e055905..406c7d2 100644 --- a/actions/hostgroups.index.yaml +++ b/actions/hostgroups.index.yaml @@ -46,15 +46,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" include: type: array required: false diff --git a/actions/hostgroups.multiple_play_roles.yaml b/actions/hostgroups.multiple_play_roles.yaml index eaa942c..46e014d 100644 --- a/actions/hostgroups.multiple_play_roles.yaml +++ b/actions/hostgroups.multiple_play_roles.yaml @@ -1,5 +1,5 @@ --- -description: "Plays Ansible roles on hostgroups (resource: POST /api/hostgroups/multiple_play_roles)" +description: "Runs all Ansible roles on hostgroups (resource: POST /api/hostgroups/multiple_play_roles)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" hostgroup_ids: type: array required: true diff --git a/actions/hostgroups.parameters_create.yaml b/actions/hostgroups.parameters_create.yaml index 278d8e4..f35bd6d 100644 --- a/actions/hostgroups.parameters_create.yaml +++ b/actions/hostgroups.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/hostgroups.parameters_hostgroup_id_updateparameters.yaml b/actions/hostgroups.parameters_hostgroup_id_updateparameters.yaml index 1cfbe4d..cf353e2 100644 --- a/actions/hostgroups.parameters_hostgroup_id_updateparameters.yaml +++ b/actions/hostgroups.parameters_hostgroup_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/hostgroups.parameters_index.yaml b/actions/hostgroups.parameters_index.yaml index 8e1abdd..284cb9d 100644 --- a/actions/hostgroups.parameters_index.yaml +++ b/actions/hostgroups.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hostgroups.play_roles.yaml b/actions/hostgroups.play_roles.yaml index fa61979..d7314d2 100644 --- a/actions/hostgroups.play_roles.yaml +++ b/actions/hostgroups.play_roles.yaml @@ -1,5 +1,5 @@ --- -description: "Plays Ansible roles on a hostgroup (resource: POST /api/hostgroups/:id/play_roles)" +description: "Runs all Ansible roles on a hostgroup (resource: POST /api/hostgroups/:id/play_roles)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hostgroups.puppetclasses_hostgroup_id_showpuppetclasses.yaml b/actions/hostgroups.puppetclasses_hostgroup_id_showpuppetclasses.yaml index fb5a5b5..1fac64f 100644 --- a/actions/hostgroups.puppetclasses_hostgroup_id_showpuppetclasses.yaml +++ b/actions/hostgroups.puppetclasses_hostgroup_id_showpuppetclasses.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false diff --git a/actions/hostgroups.puppetclasses_index.yaml b/actions/hostgroups.puppetclasses_index.yaml index 3b767dd..80044c6 100644 --- a/actions/hostgroups.puppetclasses_index.yaml +++ b/actions/hostgroups.puppetclasses_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hostgroups.rebuild_config.yaml b/actions/hostgroups.rebuild_config.yaml index 40a9e9c..1de88f3 100644 --- a/actions/hostgroups.rebuild_config.yaml +++ b/actions/hostgroups.rebuild_config.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hostgroups.show.yaml b/actions/hostgroups.show.yaml index ef63c96..53c4881 100644 --- a/actions/hostgroups.show.yaml +++ b/actions/hostgroups.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hostgroups.smart_class_parameters_index.yaml b/actions/hostgroups.smart_class_parameters_index.yaml index a37d476..c15e791 100644 --- a/actions/hostgroups.smart_class_parameters_index.yaml +++ b/actions/hostgroups.smart_class_parameters_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hostgroups.smart_variables_index.yaml b/actions/hostgroups.smart_variables_index.yaml index 1bc3fd2..ae9a46a 100644 --- a/actions/hostgroups.smart_variables_index.yaml +++ b/actions/hostgroups.smart_variables_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -55,12 +55,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hostgroups.template_combinations_create.yaml b/actions/hostgroups.template_combinations_create.yaml index 4ef2d05..a50f307 100644 --- a/actions/hostgroups.template_combinations_create.yaml +++ b/actions/hostgroups.template_combinations_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false @@ -58,11 +58,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/hostgroups.template_combinations_hostgroup_id_template_showcombinations.yaml b/actions/hostgroups.template_combinations_hostgroup_id_template_showcombinations.yaml index 7846e26..fd4c44e 100644 --- a/actions/hostgroups.template_combinations_hostgroup_id_template_showcombinations.yaml +++ b/actions/hostgroups.template_combinations_hostgroup_id_template_showcombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/hostgroups.template_combinations_hostgroup_id_template_updatecombinations.yaml b/actions/hostgroups.template_combinations_hostgroup_id_template_updatecombinations.yaml index 1f4380c..114248d 100644 --- a/actions/hostgroups.template_combinations_hostgroup_id_template_updatecombinations.yaml +++ b/actions/hostgroups.template_combinations_hostgroup_id_template_updatecombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -61,11 +61,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/hostgroups.template_combinations_index.yaml b/actions/hostgroups.template_combinations_index.yaml index c8b5bcb..e2b5cc5 100644 --- a/actions/hostgroups.template_combinations_index.yaml +++ b/actions/hostgroups.template_combinations_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/hostgroups.update.yaml b/actions/hostgroups.update.yaml index cca34ca..f3cae15 100644 --- a/actions/hostgroups.update.yaml +++ b/actions/hostgroups.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,121 +44,129 @@ parameters: description: > "description: parameters: - config_group_ids: + name: + description: Name of the host group required: false - type: array - description: IDs of associated config groups - content_source_id: + type: string + description: + description: Host group description required: false - type: number - description: Content source ID - environment_id: + type: string + parent_id: + description: Parent ID of the host group required: false type: number + environment_id: description: Environment ID - kickstart_repository_id: required: false type: number - description: Kickstart repository ID - group_parameters_attributes: - required: false - type: array - description: Array of parameters - parameters: - name: - required: false - type: string - description: Name of the parameter - value: - required: false - type: string - description: Parameter value - openscap_proxy_id: - required: false - type: number - description: ID of OpenSCAP Capsule - domain_id: + compute_profile_id: + description: Compute profile ID required: false type: number - description: Domain ID compute_resource_id: - required: false - type: number description: Compute resource ID - subnet_id: required: false type: number - description: Subnet ID - parent_id: + operatingsystem_id: + description: Operating system ID required: false type: number - description: Parent ID of the host group architecture_id: + description: Architecture ID required: false type: number - description: Architecture ID - organization_ids: + pxe_loader: + description: DHCP filename option (Grub2/PXELinux by default) required: false - type: array - description: REPLACE organizations with given ids. - operatingsystem_id: + type: string + medium_id: + description: Media ID required: false type: number - description: Operating system ID - root_pass: + ptable_id: + description: Partition table ID required: false - type: string - description: Root password on provisioned hosts - ansible_role_ids: + type: number + subnet_id: + description: Subnet ID required: false - type: array - description: IDs of associated ansible roles - description: + type: number + subnet6_id: + description: Subnet IPv6 ID required: false - type: string - description: Host group description - content_view_id: + type: number + domain_id: + description: Domain ID required: false type: number - description: Content view ID - puppet_ca_proxy_id: + realm_id: + description: Realm ID required: false type: number - description: Puppet CA Capsule ID + config_group_ids: + description: IDs of associated config groups + required: false + type: array + group_parameters_attributes: + description: Array of parameters + required: false + type: array + parameters: + name: + description: Name of the parameter + required: false + type: string + value: + description: Parameter value + required: false + type: string + parameter_type: + description: Type of value + required: false + type: string + hidden_value: + description: '' + required: false + type: boolean puppet_proxy_id: + description: Puppet proxy ID required: false type: number - description: Puppet Capsule ID - ptable_id: + puppet_ca_proxy_id: + description: Puppet CA proxy ID required: false type: number - description: Partition table ID - pxe_loader: + root_pass: + description: Root password on provisioned hosts required: false type: string - description: DHCP filename option (Grub2/PXELinux by default) - name: + location_ids: + description: REPLACE locations with given ids required: false - type: string - description: Name of the host group - medium_id: + type: array + organization_ids: + description: REPLACE organizations with given ids. + required: false + type: array + content_source_id: + description: Content source ID required: false type: number - description: Media ID - lifecycle_environment_id: + content_view_id: + description: Content view ID required: false type: number + lifecycle_environment_id: description: Lifecycle environment ID - location_ids: - required: false - type: array - description: REPLACE locations with given ids - realm_id: required: false type: number - description: Realm ID - compute_profile_id: + kickstart_repository_id: + description: Kickstart repository ID required: false type: number - description: Compute profile ID + ansible_role_ids: + description: IDs of associated ansible roles + required: false + type: array " \ No newline at end of file diff --git a/actions/hosts.ansible_roles.yaml b/actions/hosts.ansible_roles.yaml index 1b64236..459f914 100644 --- a/actions/hosts.ansible_roles.yaml +++ b/actions/hosts.ansible_roles.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.assign_ansible_roles.yaml b/actions/hosts.assign_ansible_roles.yaml new file mode 100644 index 0000000..1244aa5 --- /dev/null +++ b/actions/hosts.assign_ansible_roles.yaml @@ -0,0 +1,44 @@ +--- +description: "Assigns Ansible roles to a host (resource: POST /api/hosts/:id/assign_ansible_roles)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.assign_ansible_roles +pack: foreman +parameters: + operation: + type: string + default: hosts.assign_ansible_roles + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + ansible_role_ids: + type: array + required: true + description: "Ansible roles to assign to a host" \ No newline at end of file diff --git a/actions/hosts.audits_index.yaml b/actions/hosts.audits_index.yaml index ece8347..d59b504 100644 --- a/actions/hosts.audits_index.yaml +++ b/actions/hosts.audits_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.boot.yaml b/actions/hosts.boot.yaml index 4715451..4811f95 100644 --- a/actions/hosts.boot.yaml +++ b/actions/hosts.boot.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hosts.config_reports_last.yaml b/actions/hosts.config_reports_last.yaml index 35f10c0..353c902 100644 --- a/actions/hosts.config_reports_last.yaml +++ b/actions/hosts.config_reports_last.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.create.yaml b/actions/hosts.create.yaml index fb5a9aa..96b4066 100644 --- a/actions/hosts.create.yaml +++ b/actions/hosts.create.yaml @@ -30,344 +30,348 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host: type: object required: true description: > "description: parameters: - comment: + name: + description: '' + required: true + type: string + location_id: + description: '' + required: true + type: number + organization_id: + description: '' + required: true + type: number + environment_id: + description: required if host is managed and value is not inherited from host group required: false type: string - description: Additional information about this host - config_group_ids: + ip: + description: not required if using a subnet with DHCP proxy + required: false + type: string + mac: + description: required for managed host that is bare metal, not required if it's avirtual machine + required: false + type: string + architecture_id: + description: required if host is managed and value is not inherited from host group + required: false + type: number + domain_id: + description: required if host is managed and value is not inherited from host group + required: false + type: number + realm_id: + description: '' + required: false + type: number + puppet_proxy_id: + description: Puppet proxy ID + required: false + type: number + puppet_ca_proxy_id: + description: Puppet CA proxy ID + required: false + type: number + puppetclass_ids: + description: '' required: false type: array + config_group_ids: description: IDs of associated config groups - environment_id: + required: false + type: array + operatingsystem_id: + description: required if host is managed and value is not inherited from host group + required: false + type: string + medium_id: + description: required if not imaged based provisioning and host is managed and value isnot inherited from host group + required: false + type: string + pxe_loader: + description: DHCP filename option (Grub2/PXELinux by default) required: false type: string + ptable_id: + description: required if host is managed and custom partition has not been defined + required: false + type: number + subnet_id: description: required if host is managed and value is not inherited from host group - managed: required: false - type: boolean - description: 'True/False flag whether a host is managed or unmanaged. Note: this valuealso determines whether several parameters are required or not' - content_facet_attributes: + type: number + compute_resource_id: + description: nil means host is bare metal required: false - type: object - description: Parameters for host's content_facet facet - parameters: - content_view_id: - required: false - type: number - description: '' - kickstart_repository_id: - required: false - type: number - description: Repository Id associated with the kickstart repo used for provisioning - lifecycle_environment_id: - required: false - type: number - description: '' - content_source_id: - required: false - type: number - description: '' + type: number + root_pass: + description: required if host is managed and value is not inherited from host group ordefault password in settings + required: false + type: string model_id: + description: '' required: false type: number + hostgroup_id: description: '' - ip: + required: false + type: number + owner_id: + description: '' + required: false + type: number + owner_type: + description: Host's owner type required: false type: string - description: not required if using a subnet with DHCP Capsule + image_id: + description: '' + required: false + type: number + host_parameters_attributes: + description: Host's parameters (array or indexed hash) + required: false + type: array + parameters: + name: + description: Name of the parameter + required: true + type: string + value: + description: Parameter value + required: true + type: string + parameter_type: + description: Type of value + required: false + type: string + hidden_value: + description: '' + required: false + type: boolean + build: + description: '' + required: false + type: boolean + enabled: + description: Include this host within orcharhino reporting + required: false + type: boolean provision_method: + description: The method used to provision the host. required: false type: string - description: The method used to provision the host. + managed: + description: 'True/False flag whether a host is managed or unmanaged. Note: this valuealso determines whether several parameters are required or not' + required: false + type: boolean + progress_report_id: + description: UUID to track orchestration tasks status, GET/api/orchestration/:UUID/tasks + required: false + type: string + comment: + description: Additional information about this host + required: false + type: string + capabilities: + description: '' + required: false + type: string + compute_profile_id: + description: '' + required: false + type: number interfaces_attributes: + description: Host's network interfaces. required: false type: array - description: Host's network interfaces. parameters: - managed: - required: false - type: boolean - description: Should this interface be managed via DHCP and DNS capsule and should it beconfigured during provisioning? - ip: + mac: + description: MAC address of interface. Required for managed interfaces on bare metal. required: false type: string + ip: description: IPv4 address of interface - primary: - required: false - type: boolean - description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. - bond_options: required: false type: string - description: Space separated options, e.g. miimon=100. Only for bond interfaces. - tag: + ip6: + description: IPv6 address of interface required: false type: string - description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. - compute_attributes: - required: false - type: object - description: Additional compute resource specific attributes for the interface. - domain_id: + type: + description: Interface type, e.g. bmc. Default is interface required: false - type: number - description: Satellite domain ID of interface. Required for primary interfaces onmanaged hosts. - attached_devices: + type: string + name: + description: Interface's DNS name required: false - type: array - description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + type: string subnet_id: + description: orcharhino subnet ID of IPv4 interface required: false type: number - description: Satellite subnet ID of IPv4 interface - virtual: - required: false - type: boolean - description: Alias or VLAN device subnet6_id: + description: orcharhino subnet ID of IPv6 interface required: false type: number - description: Satellite subnet ID of IPv6 interface - provider: + domain_id: + description: orcharhino domain ID of interface. Required for primary interfaces onmanaged hosts. required: false - type: string - description: Interface provider, e.g. IPMI. Only for BMC interfaces. - type: + type: number + identifier: + description: Device identifier, e.g. eth0 or eth1.1 required: false type: string - description: Interface type, e.g. bmc. Default is interface - username: + managed: + description: Should this interface be managed via DHCP and DNS smart proxy and should itbe configured during provisioning? required: false - type: string + type: boolean + primary: + description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. + required: false + type: boolean + provision: + description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. + required: false + type: boolean + username: description: Only for BMC interfaces. - mac: required: false type: string - description: MAC address of interface. Required for managed interfaces on bare metal. - ip6: + password: + description: Only for BMC interfaces. required: false type: string - description: IPv6 address of interface - password: + provider: + description: Interface provider, e.g. IPMI. Only for BMC interfaces. required: false type: string - description: Only for BMC interfaces. - provision: + virtual: + description: Alias or VLAN device required: false type: boolean - description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. - attached_to: - required: false - type: string - description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. - name: + tag: + description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. required: false type: string - description: Interface's DNS name mtu: + description: MTU, this attribute has precedence over the subnet MTU. required: false type: number - description: MTU, this attribute has precedence over the subnet MTU. - mode: + attached_to: + description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. required: false type: string + mode: description: Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. - identifier: required: false type: string - description: Device identifier, e.g. eth0 or eth1.1 - openscap_proxy_id: - required: false - type: number - description: ID of OpenSCAP Capsule - location_id: - required: true - type: number - description: required if locations are enabled - domain_id: - required: false - type: number - description: required if host is managed and value is not inherited from host group - compute_resource_id: - required: false - type: number - description: nil means host is bare metal - subnet_id: - required: false - type: number - description: required if host is managed and value is not inherited from host group - capabilities: - required: false - type: string - description: '' - architecture_id: - required: false - type: number - description: required if host is managed and value is not inherited from host group - build: - required: false - type: boolean - description: '' - host_parameters_attributes: - required: false - type: array - description: Host's parameters (array or indexed hash) - parameters: - name: - required: true - type: string - description: Name of the parameter - value: - required: true + attached_devices: + description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + required: false + type: array + bond_options: + description: Space separated options, e.g. miimon=100. Only for bond interfaces. + required: false type: string - description: Parameter value - puppetclass_ids: - required: false - type: array - description: '' - owner_id: - required: false - type: number - description: '' - operatingsystem_id: - required: false - type: string - description: required if host is managed and value is not inherited from host group - root_pass: - required: false - type: string - description: required if host is managed and value is not inherited from host group ordefault password in settings - ansible_role_ids: - required: false - type: array - description: IDs of associated ansible roles - organization_id: - required: true - type: number - description: required if organizations are enabled - image_id: - required: false - type: number - description: '' - mac: - required: false - type: string - description: required for managed host that is bare metal, not required if it's avirtual machine - puppet_ca_proxy_id: - required: false - type: number - description: Puppet CA Capsule ID - puppet_proxy_id: - required: false - type: number - description: Puppet Capsule ID - ptable_id: - required: false - type: number - description: required if host is managed and custom partition has not been defined - progress_report_id: - required: false - type: string - description: UUID to track orchestration tasks status, GET/api/orchestration/:UUID/tasks - realm_id: - required: false - type: number - description: '' - name: - required: true - type: string - description: '' - medium_id: - required: false - type: string - description: required if not imaged based provisioning and host is managed and value isnot inherited from host group - enabled: - required: false - type: boolean - description: Include this host within Satellite reporting - hostgroup_id: - required: false - type: number - description: '' + compute_attributes: + description: Additional compute resource specific attributes for the interface. + required: false + type: object compute_attributes: - required: false - type: object description: Additional compute resource specific attributes. - owner_type: required: false - type: string - description: Host's owner type - pxe_loader: + type: object + content_facet_attributes: + description: Parameters for host's content_facet facet required: false - type: string - description: DHCP filename option (Grub2/PXELinux by default) + type: object + parameters: + content_view_id: + description: '' + required: false + type: number + lifecycle_environment_id: + description: '' + required: false + type: number + content_source_id: + description: '' + required: false + type: number + kickstart_repository_id: + description: Repository Id associated with the kickstart repo used for provisioning + required: false + type: number subscription_facet_attributes: + description: Parameters for host's subscription_facet facet required: false type: object - description: Parameters for host's subscription_facet facet parameters: + release_version: + description: Release version for this Host to use (7Server, 7.1, etc) + required: false + type: string + autoheal: + description: Sets whether the Host will autoheal subscriptions upon checkin + required: false + type: boolean purpose_usage: + description: Sets the system purpose usage required: false type: string + purpose_role: description: Sets the system purpose usage - installed_products_attributes: + required: false + type: string + purpose_addons: + description: Sets the system add-ons required: false type: array + service_level: + description: Service level to be used for autoheal + required: false + type: string + hypervisor_guest_uuids: + description: List of hypervisor guest uuids + required: false + type: array + installed_products_attributes: description: List of products installed on the host + required: false + type: array parameters: - version: + product_id: + description: Product id as listed from a host's installed products, this isnot the same product id as the products api returns required: false type: string - description: Product version - arch: + product_name: + description: Product name as listed from a host's installed products required: false type: string + arch: description: Product architecture - product_id: required: false type: string - description: Product id as listed from a host's installed products, this isnot the same product id as the products api returns - product_name: + version: + description: Product version required: false type: string - description: Product name as listed from a host's installed products - autoheal: - required: false - type: boolean - description: Sets whether the Host will autoheal subscriptions upon checkin - release_version: - required: false - type: string - description: Release version for this Host to use (7Server, 7.1, etc) - service_level: - required: false - type: string - description: Service level to be used for autoheal - purpose_role: - required: false - type: string - description: Sets the system purpose usage - purpose_addons: - required: false - type: array - description: Sets the system add-ons - hypervisor_guest_uuids: - required: false - type: array - description: List of hypervisor guest uuids - compute_profile_id: + ansible_role_ids: + description: IDs of associated ansible roles required: false - type: number - description: '' + type: array " \ No newline at end of file diff --git a/actions/hosts.destroy.yaml b/actions/hosts.destroy.yaml index 611367a..e640366 100644 --- a/actions/hosts.destroy.yaml +++ b/actions/hosts.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.disassociate.yaml b/actions/hosts.disassociate.yaml index 26a294d..9ddb6cb 100644 --- a/actions/hosts.disassociate.yaml +++ b/actions/hosts.disassociate.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.enc.yaml b/actions/hosts.enc.yaml index dd5d698..198a4df 100644 --- a/actions/hosts.enc.yaml +++ b/actions/hosts.enc.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.fact_values_index.yaml b/actions/hosts.fact_values_index.yaml index 8a04aef..b1d5fc0 100644 --- a/actions/hosts.fact_values_index.yaml +++ b/actions/hosts.fact_values_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.facts.yaml b/actions/hosts.facts.yaml index 027e653..f9b129f 100644 --- a/actions/hosts.facts.yaml +++ b/actions/hosts.facts.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" name: type: string required: true diff --git a/actions/hosts.host_classes_create.yaml b/actions/hosts.host_classes_create.yaml index 2fcf3ff..790ddd9 100644 --- a/actions/hosts.host_classes_create.yaml +++ b/actions/hosts.host_classes_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true diff --git a/actions/hosts.host_classes_host_id_puppetclass_destroyids.yaml b/actions/hosts.host_classes_host_id_puppetclass_destroyids.yaml index cbb7a3d..cd74dae 100644 --- a/actions/hosts.host_classes_host_id_puppetclass_destroyids.yaml +++ b/actions/hosts.host_classes_host_id_puppetclass_destroyids.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true diff --git a/actions/hosts.host_classes_index.yaml b/actions/hosts.host_classes_index.yaml index 6131b48..dc0800b 100644 --- a/actions/hosts.host_classes_index.yaml +++ b/actions/hosts.host_classes_index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/hosts.host_collections.yaml b/actions/hosts.host_collections.yaml index 5d44394..df7eab7 100644 --- a/actions/hosts.host_collections.yaml +++ b/actions/hosts.host_collections.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: number required: true diff --git a/actions/hosts.host_debs_index.yaml b/actions/hosts.host_debs_index.yaml new file mode 100644 index 0000000..0e97ade --- /dev/null +++ b/actions/hosts.host_debs_index.yaml @@ -0,0 +1,61 @@ +--- +description: "List deb packages installed on the host (resource: GET /api/hosts/:host_id/debs)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.host_debs_index +pack: foreman +parameters: + operation: + type: string + default: hosts.host_debs_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + host_id: + type: number + required: true + description: "ID of the host" + search: + type: string + required: false + description: "Search string" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" + order: + type: string + required: false + description: "Sort field and order, eg. 'id DESC'" + full_result: + type: boolean + required: false + description: "Whether or not to show all results" + sort_by: + type: string + required: false + description: "Field to sort the results on" + sort_order: + type: string + required: false + description: "How to order the sorted results (e.g. ASC for ascending)" \ No newline at end of file diff --git a/actions/hosts.host_errata_apply.yaml b/actions/hosts.host_errata_apply.yaml index d8996e6..f702f02 100644 --- a/actions/hosts.host_errata_apply.yaml +++ b/actions/hosts.host_errata_apply.yaml @@ -33,5 +33,31 @@ parameters: description: "Host ID" errata_ids: type: array + required: false + description: "List of Errata ids to install" + included: + type: object + required: true + description: > + "description: Errata to exclusively include in the action + parameters: + search: + description: Search string for erratum to perform an action on + required: false + type: string + ids: + description: 'List of errata ids to perform an action on, (ex: RHSA-2019:1168)' + required: false + type: array + " + excluded: + type: object required: true - description: "List of Errata ids to install" \ No newline at end of file + description: > + "description: Errata to explicitly exclude in the action. All other applicable erratawill be included in the action, unless an included parameter is passed aswell. + parameters: + ids: + description: List of errata ids to exclude and not run an action on, (ex:RHSA-2019:1168) + required: false + type: array + " \ No newline at end of file diff --git a/actions/hosts.host_subscriptions_add_subscriptions.yaml b/actions/hosts.host_subscriptions_add_subscriptions.yaml index b2abbee..26c31ec 100644 --- a/actions/hosts.host_subscriptions_add_subscriptions.yaml +++ b/actions/hosts.host_subscriptions_add_subscriptions.yaml @@ -38,11 +38,11 @@ parameters: "description: Array of subscriptions to add parameters: id: + description: Subscription Pool id required: true type: string - description: Subscription Pool id quantity: + description: Quantity of this subscriptions to add required: true type: number - description: Quantity of this subscriptions to add " \ No newline at end of file diff --git a/actions/hosts.host_subscriptions_content_override.yaml b/actions/hosts.host_subscriptions_content_override.yaml index 3fda832..06ca129 100644 --- a/actions/hosts.host_subscriptions_content_override.yaml +++ b/actions/hosts.host_subscriptions_content_override.yaml @@ -46,19 +46,19 @@ parameters: "description: Array of Content override parameters parameters: content_label: + description: Label of the content required: true type: string - description: Label of the content - name: + value: + description: Override value. Provide a boolean value if name is 'enabled' required: false type: string + name: description: Override key or name. Note if name is not provided the default name will be'enabled' - value: required: false type: string - description: Override value. Provide a boolean value if name is 'enabled' remove: + description: Set true to remove an override and reset it to 'default' required: false type: boolean - description: Set true to remove an override and reset it to 'default' " \ No newline at end of file diff --git a/actions/hosts.host_subscriptions_create.yaml b/actions/hosts.host_subscriptions_create.yaml index 2565a2a..02998dd 100644 --- a/actions/hosts.host_subscriptions_create.yaml +++ b/actions/hosts.host_subscriptions_create.yaml @@ -49,22 +49,22 @@ parameters: description: > "description: List of products installed on the host parameters: - version: + product_id: + description: Product id as listed from a host's installed products, this isnot the same product id as the products api returns required: false type: string - description: Product version - arch: + product_name: + description: Product name as listed from a host's installed products required: false type: string + arch: description: Product architecture - product_id: required: false type: string - description: Product id as listed from a host's installed products, this isnot the same product id as the products api returns - product_name: + version: + description: Product version required: false type: string - description: Product name as listed from a host's installed products " release_version: type: string diff --git a/actions/hosts.host_subscriptions_remove_subscriptions.yaml b/actions/hosts.host_subscriptions_remove_subscriptions.yaml index 864fba6..da8f8dd 100644 --- a/actions/hosts.host_subscriptions_remove_subscriptions.yaml +++ b/actions/hosts.host_subscriptions_remove_subscriptions.yaml @@ -38,11 +38,11 @@ parameters: "description: Array of subscriptions to remove parameters: id: + description: Subscription Pool id required: true type: string - description: Subscription Pool id quantity: + description: If specified, remove the first instance of a subscription with matching idand quantity required: false type: number - description: If specified, remove the first instance of a subscription with matching idand quantity " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_add_subscriptions.yaml b/actions/hosts.hosts_bulk_actions_add_subscriptions.yaml index 804bce0..e0eca7e 100644 --- a/actions/hosts.hosts_bulk_actions_add_subscriptions.yaml +++ b/actions/hosts.hosts_bulk_actions_add_subscriptions.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " subscriptions: type: array @@ -64,11 +64,11 @@ parameters: "description: Array of subscriptions to add parameters: id: + description: Subscription Pool id required: true type: string - description: Subscription Pool id quantity: + description: Quantity of this subscriptions to add required: true type: number - description: Quantity of this subscriptions to add " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_applicable_errata.yaml b/actions/hosts.hosts_bulk_actions_applicable_errata.yaml index 76ad1f6..726cf94 100644 --- a/actions/hosts.hosts_bulk_actions_applicable_errata.yaml +++ b/actions/hosts.hosts_bulk_actions_applicable_errata.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,7 +53,7 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_auto_attach.yaml b/actions/hosts.hosts_bulk_actions_auto_attach.yaml index c7d0e86..e30bd2c 100644 --- a/actions/hosts.hosts_bulk_actions_auto_attach.yaml +++ b/actions/hosts.hosts_bulk_actions_auto_attach.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,7 +53,7 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_available_incremental_updates.yaml b/actions/hosts.hosts_bulk_actions_available_incremental_updates.yaml index d8eaa64..2a9594a 100644 --- a/actions/hosts.hosts_bulk_actions_available_incremental_updates.yaml +++ b/actions/hosts.hosts_bulk_actions_available_incremental_updates.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " errata_ids: type: array diff --git a/actions/hosts.hosts_bulk_actions_bulk_add_host_collections.yaml b/actions/hosts.hosts_bulk_actions_bulk_add_host_collections.yaml index 980b5e5..ebb088a 100644 --- a/actions/hosts.hosts_bulk_actions_bulk_add_host_collections.yaml +++ b/actions/hosts.hosts_bulk_actions_bulk_add_host_collections.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " host_collection_ids: type: array diff --git a/actions/hosts.hosts_bulk_actions_bulk_remove_host_collections.yaml b/actions/hosts.hosts_bulk_actions_bulk_remove_host_collections.yaml index 80569cb..2f8ad4a 100644 --- a/actions/hosts.hosts_bulk_actions_bulk_remove_host_collections.yaml +++ b/actions/hosts.hosts_bulk_actions_bulk_remove_host_collections.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " host_collection_ids: type: array diff --git a/actions/hosts.hosts_bulk_actions_content_overrides.yaml b/actions/hosts.hosts_bulk_actions_content_overrides.yaml index bfa3ffb..5de7d06 100644 --- a/actions/hosts.hosts_bulk_actions_content_overrides.yaml +++ b/actions/hosts.hosts_bulk_actions_content_overrides.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " content_overrides: type: array @@ -64,19 +64,19 @@ parameters: "description: Array of Content override parameters parameters: content_label: + description: Label of the content required: true type: string - description: Label of the content - name: + value: + description: Override value. Provide a boolean value if name is 'enabled' required: false type: string + name: description: Override key or name. Note if name is not provided the default name will be'enabled' - value: required: false type: string - description: Override value. Provide a boolean value if name is 'enabled' remove: + description: Set true to remove an override and reset it to 'default' required: false type: boolean - description: Set true to remove an override and reset it to 'default' " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_destroy_hosts.yaml b/actions/hosts.hosts_bulk_actions_destroy_hosts.yaml index 3bdc8ed..4e27190 100644 --- a/actions/hosts.hosts_bulk_actions_destroy_hosts.yaml +++ b/actions/hosts.hosts_bulk_actions_destroy_hosts.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,7 +53,7 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_environment_content_view.yaml b/actions/hosts.hosts_bulk_actions_environment_content_view.yaml index a2f807b..24a78f7 100644 --- a/actions/hosts.hosts_bulk_actions_environment_content_view.yaml +++ b/actions/hosts.hosts_bulk_actions_environment_content_view.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " environment_id: type: number diff --git a/actions/hosts.hosts_bulk_actions_install_content.yaml b/actions/hosts.hosts_bulk_actions_install_content.yaml index a02f856..1a985d2 100644 --- a/actions/hosts.hosts_bulk_actions_install_content.yaml +++ b/actions/hosts.hosts_bulk_actions_install_content.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " content_type: type: string diff --git a/actions/hosts.hosts_bulk_actions_installable_errata.yaml b/actions/hosts.hosts_bulk_actions_installable_errata.yaml index e1e2d38..8b641db 100644 --- a/actions/hosts.hosts_bulk_actions_installable_errata.yaml +++ b/actions/hosts.hosts_bulk_actions_installable_errata.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,7 +53,7 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_module_streams.yaml b/actions/hosts.hosts_bulk_actions_module_streams.yaml index 4abbc48..69c142a 100644 --- a/actions/hosts.hosts_bulk_actions_module_streams.yaml +++ b/actions/hosts.hosts_bulk_actions_module_streams.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,7 +53,7 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_release_version.yaml b/actions/hosts.hosts_bulk_actions_release_version.yaml index 533483d..fc7a7f8 100644 --- a/actions/hosts.hosts_bulk_actions_release_version.yaml +++ b/actions/hosts.hosts_bulk_actions_release_version.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " release_version: type: string diff --git a/actions/hosts.hosts_bulk_actions_remove_content.yaml b/actions/hosts.hosts_bulk_actions_remove_content.yaml index 8e2b801..9d9d122 100644 --- a/actions/hosts.hosts_bulk_actions_remove_content.yaml +++ b/actions/hosts.hosts_bulk_actions_remove_content.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " content_type: type: string diff --git a/actions/hosts.hosts_bulk_actions_remove_subscriptions.yaml b/actions/hosts.hosts_bulk_actions_remove_subscriptions.yaml index 3776ad2..529df11 100644 --- a/actions/hosts.hosts_bulk_actions_remove_subscriptions.yaml +++ b/actions/hosts.hosts_bulk_actions_remove_subscriptions.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " subscriptions: type: array @@ -64,11 +64,11 @@ parameters: "description: Array of subscriptions to remove parameters: id: + description: Subscription Pool id required: true type: string - description: Subscription Pool id quantity: + description: Quantity of specified subscription to remove required: false type: number - description: Quantity of specified subscription to remove " \ No newline at end of file diff --git a/actions/hosts.hosts_bulk_actions_update_content.yaml b/actions/hosts.hosts_bulk_actions_update_content.yaml index 57b38f6..b41f93f 100644 --- a/actions/hosts.hosts_bulk_actions_update_content.yaml +++ b/actions/hosts.hosts_bulk_actions_update_content.yaml @@ -38,13 +38,13 @@ parameters: "description: parameters: search: + description: Search string for hosts to perform an action on required: false type: string - description: Search string for hosts to perform an action on ids: + description: List of host ids to perform an action on required: false type: array - description: List of host ids to perform an action on " excluded: type: object @@ -53,9 +53,9 @@ parameters: "description: parameters: ids: + description: List of host ids to exclude and not run an action on required: false type: array - description: List of host ids to exclude and not run an action on " content_type: type: string diff --git a/actions/hosts.id_get_statusstatus.yaml b/actions/hosts.id_get_statusstatus.yaml index a3823c1..d0aa33a 100644 --- a/actions/hosts.id_get_statusstatus.yaml +++ b/actions/hosts.id_get_statusstatus.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hosts.id_templatetemplate.yaml b/actions/hosts.id_templatetemplate.yaml index c9b8f75..1afc9a1 100644 --- a/actions/hosts.id_templatetemplate.yaml +++ b/actions/hosts.id_templatetemplate.yaml @@ -30,15 +30,15 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true kind: type: string required: true - description: "Template kinds, available values: Bootdisk, PXELinux, PXEGrub, PXEGrub2,iPXE, provision, finish, script, user_data, ZTP, POAP, kexec" \ No newline at end of file + description: "Template kinds, available values: Bootdisk, PXELinux, PXEGrub, PXEGrub2,iPXE, provision, finish, script, user_data, ZTP, POAP, kexec, cloud-init" \ No newline at end of file diff --git a/actions/hosts.index.yaml b/actions/hosts.index.yaml index 52029be..cb568b5 100644 --- a/actions/hosts.index.yaml +++ b/actions/hosts.index.yaml @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.interfaces_create.yaml b/actions/hosts.interfaces_create.yaml index 085304f..1f43129 100644 --- a/actions/hosts.interfaces_create.yaml +++ b/actions/hosts.interfaces_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -45,96 +45,96 @@ parameters: description: > "description: interface information parameters: - managed: - required: false - type: boolean - description: Should this interface be managed via DHCP and DNS capsule and should it beconfigured during provisioning? - ip: + mac: + description: MAC address of interface. Required for managed interfaces on bare metal. required: false type: string + ip: description: IPv4 address of interface - primary: - required: false - type: boolean - description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. - bond_options: required: false type: string - description: Space separated options, e.g. miimon=100. Only for bond interfaces. - tag: + ip6: + description: IPv6 address of interface required: false type: string - description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. - compute_attributes: - required: false - type: object - description: Additional compute resource specific attributes for the interface. - domain_id: + type: + description: Interface type, e.g. bmc. Default is interface required: false - type: number - description: Satellite domain ID of interface. Required for primary interfaces onmanaged hosts. - attached_devices: + type: string + name: + description: Interface's DNS name required: false - type: array - description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + type: string subnet_id: + description: orcharhino subnet ID of IPv4 interface required: false type: number - description: Satellite subnet ID of IPv4 interface - virtual: - required: false - type: boolean - description: Alias or VLAN device subnet6_id: + description: orcharhino subnet ID of IPv6 interface required: false type: number - description: Satellite subnet ID of IPv6 interface - provider: + domain_id: + description: orcharhino domain ID of interface. Required for primary interfaces onmanaged hosts. required: false - type: string - description: Interface provider, e.g. IPMI. Only for BMC interfaces. - type: + type: number + identifier: + description: Device identifier, e.g. eth0 or eth1.1 required: false type: string - description: Interface type, e.g. bmc. Default is interface - username: + managed: + description: Should this interface be managed via DHCP and DNS smart proxy and should itbe configured during provisioning? required: false - type: string + type: boolean + primary: + description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. + required: false + type: boolean + provision: + description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. + required: false + type: boolean + username: description: Only for BMC interfaces. - mac: required: false type: string - description: MAC address of interface. Required for managed interfaces on bare metal. - ip6: + password: + description: Only for BMC interfaces. required: false type: string - description: IPv6 address of interface - password: + provider: + description: Interface provider, e.g. IPMI. Only for BMC interfaces. required: false type: string - description: Only for BMC interfaces. - provision: + virtual: + description: Alias or VLAN device required: false type: boolean - description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. - attached_to: - required: false - type: string - description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. - name: + tag: + description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. required: false type: string - description: Interface's DNS name mtu: + description: MTU, this attribute has precedence over the subnet MTU. required: false type: number - description: MTU, this attribute has precedence over the subnet MTU. - mode: + attached_to: + description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. required: false type: string + mode: description: Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. - identifier: required: false type: string - description: Device identifier, e.g. eth0 or eth1.1 + attached_devices: + description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + required: false + type: array + bond_options: + description: Space separated options, e.g. miimon=100. Only for bond interfaces. + required: false + type: string + compute_attributes: + description: Additional compute resource specific attributes for the interface. + required: false + type: object " \ No newline at end of file diff --git a/actions/hosts.interfaces_host_id_destroyinterfaces.yaml b/actions/hosts.interfaces_host_id_destroyinterfaces.yaml index 619d325..3d400cf 100644 --- a/actions/hosts.interfaces_host_id_destroyinterfaces.yaml +++ b/actions/hosts.interfaces_host_id_destroyinterfaces.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true diff --git a/actions/hosts.interfaces_host_id_showinterfaces.yaml b/actions/hosts.interfaces_host_id_showinterfaces.yaml index 711844f..8ccfa54 100644 --- a/actions/hosts.interfaces_host_id_showinterfaces.yaml +++ b/actions/hosts.interfaces_host_id_showinterfaces.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true diff --git a/actions/hosts.interfaces_host_id_updateinterfaces.yaml b/actions/hosts.interfaces_host_id_updateinterfaces.yaml index 301bf4a..83f1d51 100644 --- a/actions/hosts.interfaces_host_id_updateinterfaces.yaml +++ b/actions/hosts.interfaces_host_id_updateinterfaces.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -49,96 +49,96 @@ parameters: description: > "description: interface information parameters: - managed: - required: false - type: boolean - description: Should this interface be managed via DHCP and DNS capsule and should it beconfigured during provisioning? - ip: + mac: + description: MAC address of interface. Required for managed interfaces on bare metal. required: false type: string + ip: description: IPv4 address of interface - primary: - required: false - type: boolean - description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. - bond_options: required: false type: string - description: Space separated options, e.g. miimon=100. Only for bond interfaces. - tag: + ip6: + description: IPv6 address of interface required: false type: string - description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. - compute_attributes: - required: false - type: object - description: Additional compute resource specific attributes for the interface. - domain_id: + type: + description: Interface type, e.g. bmc. Default is interface required: false - type: number - description: Satellite domain ID of interface. Required for primary interfaces onmanaged hosts. - attached_devices: + type: string + name: + description: Interface's DNS name required: false - type: array - description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + type: string subnet_id: + description: orcharhino subnet ID of IPv4 interface required: false type: number - description: Satellite subnet ID of IPv4 interface - virtual: - required: false - type: boolean - description: Alias or VLAN device subnet6_id: + description: orcharhino subnet ID of IPv6 interface required: false type: number - description: Satellite subnet ID of IPv6 interface - provider: + domain_id: + description: orcharhino domain ID of interface. Required for primary interfaces onmanaged hosts. required: false - type: string - description: Interface provider, e.g. IPMI. Only for BMC interfaces. - type: + type: number + identifier: + description: Device identifier, e.g. eth0 or eth1.1 required: false type: string - description: Interface type, e.g. bmc. Default is interface - username: + managed: + description: Should this interface be managed via DHCP and DNS smart proxy and should itbe configured during provisioning? required: false - type: string + type: boolean + primary: + description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. + required: false + type: boolean + provision: + description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. + required: false + type: boolean + username: description: Only for BMC interfaces. - mac: required: false type: string - description: MAC address of interface. Required for managed interfaces on bare metal. - ip6: + password: + description: Only for BMC interfaces. required: false type: string - description: IPv6 address of interface - password: + provider: + description: Interface provider, e.g. IPMI. Only for BMC interfaces. required: false type: string - description: Only for BMC interfaces. - provision: + virtual: + description: Alias or VLAN device required: false type: boolean - description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. - attached_to: - required: false - type: string - description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. - name: + tag: + description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. required: false type: string - description: Interface's DNS name mtu: + description: MTU, this attribute has precedence over the subnet MTU. required: false type: number - description: MTU, this attribute has precedence over the subnet MTU. - mode: + attached_to: + description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. required: false type: string + mode: description: Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. - identifier: required: false type: string - description: Device identifier, e.g. eth0 or eth1.1 + attached_devices: + description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + required: false + type: array + bond_options: + description: Space separated options, e.g. miimon=100. Only for bond interfaces. + required: false + type: string + compute_attributes: + description: Additional compute resource specific attributes for the interface. + required: false + type: object " \ No newline at end of file diff --git a/actions/hosts.interfaces_index.yaml b/actions/hosts.interfaces_index.yaml index d94497d..28eeafa 100644 --- a/actions/hosts.interfaces_index.yaml +++ b/actions/hosts.interfaces_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -48,10 +48,10 @@ parameters: required: false description: "ID or name of subnet" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.multiple_play_roles.yaml b/actions/hosts.multiple_play_roles.yaml index ee32f06..e3d087e 100644 --- a/actions/hosts.multiple_play_roles.yaml +++ b/actions/hosts.multiple_play_roles.yaml @@ -1,5 +1,5 @@ --- -description: "Plays Ansible roles on hosts (resource: POST /api/hosts/multiple_play_roles)" +description: "Runs all Ansible roles on hosts (resource: POST /api/hosts/multiple_play_roles)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_ids: type: array required: true diff --git a/actions/hosts.parameters_create.yaml b/actions/hosts.parameters_create.yaml index 440711b..8823f02 100644 --- a/actions/hosts.parameters_create.yaml +++ b/actions/hosts.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/hosts.parameters_host_id_updateparameters.yaml b/actions/hosts.parameters_host_id_updateparameters.yaml index 544c385..22718e5 100644 --- a/actions/hosts.parameters_host_id_updateparameters.yaml +++ b/actions/hosts.parameters_host_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/hosts.parameters_index.yaml b/actions/hosts.parameters_index.yaml index 21546d0..8b77441 100644 --- a/actions/hosts.parameters_index.yaml +++ b/actions/hosts.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.play_roles.yaml b/actions/hosts.play_roles.yaml index d9e377a..39da03d 100644 --- a/actions/hosts.play_roles.yaml +++ b/actions/hosts.play_roles.yaml @@ -1,5 +1,5 @@ --- -description: "Plays Ansible roles on a host (resource: POST /api/hosts/:id/play_roles)" +description: "Runs all Ansible roles on a host (resource: POST /api/hosts/:id/play_roles)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.power.yaml b/actions/hosts.power.yaml index c7636f5..a0f4eaf 100644 --- a/actions/hosts.power.yaml +++ b/actions/hosts.power.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hosts.power_status.yaml b/actions/hosts.power_status.yaml new file mode 100644 index 0000000..6bc197a --- /dev/null +++ b/actions/hosts.power_status.yaml @@ -0,0 +1,40 @@ +--- +description: "Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs. (resource: GET /api/hosts/:id/power)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.power_status +pack: foreman +parameters: + operation: + type: string + default: hosts.power_status + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true \ No newline at end of file diff --git a/actions/hosts.puppet_hosts_puppetrun.yaml b/actions/hosts.puppet_hosts_puppetrun.yaml index 49b9b0e..aad8167 100644 --- a/actions/hosts.puppet_hosts_puppetrun.yaml +++ b/actions/hosts.puppet_hosts_puppetrun.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.puppetclasses_host_id_showpuppetclasses.yaml b/actions/hosts.puppetclasses_host_id_showpuppetclasses.yaml index 162a877..abe5280 100644 --- a/actions/hosts.puppetclasses_host_id_showpuppetclasses.yaml +++ b/actions/hosts.puppetclasses_host_id_showpuppetclasses.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true diff --git a/actions/hosts.puppetclasses_index.yaml b/actions/hosts.puppetclasses_index.yaml index b73d2af..400afda 100644 --- a/actions/hosts.puppetclasses_index.yaml +++ b/actions/hosts.puppetclasses_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.rebuild_config.yaml b/actions/hosts.rebuild_config.yaml index fb543b0..118fdfb 100644 --- a/actions/hosts.rebuild_config.yaml +++ b/actions/hosts.rebuild_config.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hosts.reports_last.yaml b/actions/hosts.reports_last.yaml index b3d7dbc..8a8b5aa 100644 --- a/actions/hosts.reports_last.yaml +++ b/actions/hosts.reports_last.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.show.yaml b/actions/hosts.show.yaml index 5b79144..44614fe 100644 --- a/actions/hosts.show.yaml +++ b/actions/hosts.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/hosts.smart_class_parameters_index.yaml b/actions/hosts.smart_class_parameters_index.yaml index 593b7ce..dafa651 100644 --- a/actions/hosts.smart_class_parameters_index.yaml +++ b/actions/hosts.smart_class_parameters_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.smart_variables_index.yaml b/actions/hosts.smart_variables_index.yaml index afb9eb4..3aed12c 100644 --- a/actions/hosts.smart_variables_index.yaml +++ b/actions/hosts.smart_variables_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -55,12 +55,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.snapshots_create.yaml b/actions/hosts.snapshots_create.yaml new file mode 100644 index 0000000..b8a7fa3 --- /dev/null +++ b/actions/hosts.snapshots_create.yaml @@ -0,0 +1,59 @@ +--- +description: "Create a snapshot (resource: POST /api/hosts/:host_id/snapshots)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.snapshots_create +pack: foreman +parameters: + operation: + type: string + default: hosts.snapshots_create + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_id: + type: string + required: true + include_ram: + type: boolean + required: false + description: "Whether to include the RAM state in the snapshot" + snapshot: + type: object + required: true + description: > + "description: + parameters: + name: + description: Name of this snapshot + required: true + type: string + description: + description: Description of this snapshot + required: false + type: string + " \ No newline at end of file diff --git a/actions/hosts.snapshots_host_id_destroysnapshots.yaml b/actions/hosts.snapshots_host_id_destroysnapshots.yaml new file mode 100644 index 0000000..e4a5cb5 --- /dev/null +++ b/actions/hosts.snapshots_host_id_destroysnapshots.yaml @@ -0,0 +1,43 @@ +--- +description: "Delete a snapshot (resource: DELETE /api/hosts/:host_id/snapshots/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.snapshots_host_id_destroysnapshots +pack: foreman +parameters: + operation: + type: string + default: hosts.snapshots_host_id_destroysnapshots + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_id: + type: string + required: true + id: + type: string + required: true \ No newline at end of file diff --git a/actions/hosts.snapshots_host_id_revertsnapshots.yaml b/actions/hosts.snapshots_host_id_revertsnapshots.yaml new file mode 100644 index 0000000..8621e10 --- /dev/null +++ b/actions/hosts.snapshots_host_id_revertsnapshots.yaml @@ -0,0 +1,43 @@ +--- +description: "Revert Host to a snapshot (resource: PUT /api/hosts/:host_id/snapshots/:id/revert)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.snapshots_host_id_revertsnapshots +pack: foreman +parameters: + operation: + type: string + default: hosts.snapshots_host_id_revertsnapshots + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_id: + type: string + required: true + id: + type: string + required: true \ No newline at end of file diff --git a/actions/hosts.snapshots_host_id_showsnapshots.yaml b/actions/hosts.snapshots_host_id_showsnapshots.yaml new file mode 100644 index 0000000..472ae41 --- /dev/null +++ b/actions/hosts.snapshots_host_id_showsnapshots.yaml @@ -0,0 +1,43 @@ +--- +description: "Show a snapshot (resource: GET /api/hosts/:host_id/snapshots/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.snapshots_host_id_showsnapshots +pack: foreman +parameters: + operation: + type: string + default: hosts.snapshots_host_id_showsnapshots + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_id: + type: string + required: true + id: + type: string + required: true \ No newline at end of file diff --git a/actions/hosts.snapshots_host_id_updatesnapshots.yaml b/actions/hosts.snapshots_host_id_updatesnapshots.yaml new file mode 100644 index 0000000..cb354a5 --- /dev/null +++ b/actions/hosts.snapshots_host_id_updatesnapshots.yaml @@ -0,0 +1,58 @@ +--- +description: "Update a snapshot (resource: PUT /api/hosts/:host_id/snapshots/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.snapshots_host_id_updatesnapshots +pack: foreman +parameters: + operation: + type: string + default: hosts.snapshots_host_id_updatesnapshots + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_id: + type: string + required: true + id: + type: string + required: true + snapshot: + type: object + required: true + description: > + "description: + parameters: + name: + description: Name of this snapshot + required: false + type: string + description: + description: Description of this snapshot + required: false + type: string + " \ No newline at end of file diff --git a/actions/hosts.snapshots_index.yaml b/actions/hosts.snapshots_index.yaml new file mode 100644 index 0000000..b129a4b --- /dev/null +++ b/actions/hosts.snapshots_index.yaml @@ -0,0 +1,56 @@ +--- +description: "List all snapshots (resource: GET /api/hosts/:host_id/snapshots)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: hosts.snapshots_index +pack: foreman +parameters: + operation: + type: string + default: hosts.snapshots_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + host_id: + type: string + required: true + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/hosts.status.yaml b/actions/hosts.status.yaml index 6c16d81..72ec0f5 100644 --- a/actions/hosts.status.yaml +++ b/actions/hosts.status.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/hosts.update.yaml b/actions/hosts.update.yaml index cc0b379..24dd06f 100644 --- a/actions/hosts.update.yaml +++ b/actions/hosts.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,333 +44,337 @@ parameters: description: > "description: parameters: - comment: + name: + description: '' required: false type: string - description: Additional information about this host - config_group_ids: + location_id: + description: '' + required: false + type: number + organization_id: + description: '' + required: false + type: number + environment_id: + description: required if host is managed and value is not inherited from host group + required: false + type: string + ip: + description: not required if using a subnet with DHCP proxy + required: false + type: string + mac: + description: required for managed host that is bare metal, not required if it's avirtual machine + required: false + type: string + architecture_id: + description: required if host is managed and value is not inherited from host group + required: false + type: number + domain_id: + description: required if host is managed and value is not inherited from host group + required: false + type: number + realm_id: + description: '' + required: false + type: number + puppet_proxy_id: + description: Puppet proxy ID + required: false + type: number + puppet_ca_proxy_id: + description: Puppet CA proxy ID + required: false + type: number + puppetclass_ids: + description: '' required: false type: array + config_group_ids: description: IDs of associated config groups - environment_id: + required: false + type: array + operatingsystem_id: + description: required if host is managed and value is not inherited from host group + required: false + type: string + medium_id: + description: required if not imaged based provisioning and host is managed and value isnot inherited from host group + required: false + type: string + pxe_loader: + description: DHCP filename option (Grub2/PXELinux by default) required: false type: string + ptable_id: + description: required if host is managed and custom partition has not been defined + required: false + type: number + subnet_id: description: required if host is managed and value is not inherited from host group - managed: required: false - type: boolean - description: 'True/False flag whether a host is managed or unmanaged. Note: this valuealso determines whether several parameters are required or not' - content_facet_attributes: + type: number + compute_resource_id: + description: nil means host is bare metal required: false - type: object - description: Parameters for host's content_facet facet + type: number + root_pass: + description: required if host is managed and value is not inherited from host group ordefault password in settings + required: false + type: string + model_id: + description: '' + required: false + type: number + hostgroup_id: + description: '' + required: false + type: number + owner_id: + description: '' + required: false + type: number + owner_type: + description: Host's owner type + required: false + type: string + image_id: + description: '' + required: false + type: number + host_parameters_attributes: + description: Host's parameters (array or indexed hash) + required: false + type: array parameters: - content_view_id: + name: + description: Name of the parameter required: false - type: number - description: '' - kickstart_repository_id: + type: string + value: + description: Parameter value required: false - type: number - description: Repository Id associated with the kickstart repo used for provisioning - lifecycle_environment_id: + type: string + parameter_type: + description: Type of value required: false - type: number + type: string + hidden_value: description: '' - content_source_id: required: false - type: number - description: '' - model_id: - required: false - type: number + type: boolean + build: description: '' - ip: required: false - type: string - description: not required if using a subnet with DHCP Capsule + type: boolean + enabled: + description: Include this host within orcharhino reporting + required: false + type: boolean provision_method: + description: The method used to provision the host. required: false type: string - description: The method used to provision the host. + managed: + description: 'True/False flag whether a host is managed or unmanaged. Note: this valuealso determines whether several parameters are required or not' + required: false + type: boolean + progress_report_id: + description: UUID to track orchestration tasks status, GET/api/orchestration/:UUID/tasks + required: false + type: string + comment: + description: Additional information about this host + required: false + type: string + capabilities: + description: '' + required: false + type: string + compute_profile_id: + description: '' + required: false + type: number interfaces_attributes: + description: Host's network interfaces. required: false type: array - description: Host's network interfaces. parameters: - managed: - required: false - type: boolean - description: Should this interface be managed via DHCP and DNS capsule and should it beconfigured during provisioning? - ip: + mac: + description: MAC address of interface. Required for managed interfaces on bare metal. required: false type: string + ip: description: IPv4 address of interface - primary: - required: false - type: boolean - description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. - bond_options: required: false type: string - description: Space separated options, e.g. miimon=100. Only for bond interfaces. - tag: + ip6: + description: IPv6 address of interface required: false type: string - description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. - compute_attributes: - required: false - type: object - description: Additional compute resource specific attributes for the interface. - domain_id: + type: + description: Interface type, e.g. bmc. Default is interface required: false - type: number - description: Satellite domain ID of interface. Required for primary interfaces onmanaged hosts. - attached_devices: + type: string + name: + description: Interface's DNS name required: false - type: array - description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. + type: string subnet_id: + description: orcharhino subnet ID of IPv4 interface required: false type: number - description: Satellite subnet ID of IPv4 interface - virtual: - required: false - type: boolean - description: Alias or VLAN device subnet6_id: + description: orcharhino subnet ID of IPv6 interface required: false type: number - description: Satellite subnet ID of IPv6 interface - provider: + domain_id: + description: orcharhino domain ID of interface. Required for primary interfaces onmanaged hosts. required: false - type: string - description: Interface provider, e.g. IPMI. Only for BMC interfaces. - type: + type: number + identifier: + description: Device identifier, e.g. eth0 or eth1.1 required: false type: string - description: Interface type, e.g. bmc. Default is interface - username: + managed: + description: Should this interface be managed via DHCP and DNS smart proxy and should itbe configured during provisioning? required: false - type: string + type: boolean + primary: + description: Should this interface be used for constructing the FQDN of the host? Eachmanaged hosts needs to have one primary interface. + required: false + type: boolean + provision: + description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. + required: false + type: boolean + username: description: Only for BMC interfaces. - mac: required: false type: string - description: MAC address of interface. Required for managed interfaces on bare metal. - ip6: + password: + description: Only for BMC interfaces. required: false type: string - description: IPv6 address of interface - password: + provider: + description: Interface provider, e.g. IPMI. Only for BMC interfaces. required: false type: string - description: Only for BMC interfaces. - provision: + virtual: + description: Alias or VLAN device required: false type: boolean - description: Should this interface be used for TFTP of PXELinux (or SSH for image-basedhosts)? Each managed hosts needs to have one provision interface. - attached_to: - required: false - type: string - description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. - name: + tag: + description: VLAN tag, this attribute has precedence over the subnet VLAN ID. Only forvirtual interfaces. required: false type: string - description: Interface's DNS name mtu: + description: MTU, this attribute has precedence over the subnet MTU. required: false type: number - description: MTU, this attribute has precedence over the subnet MTU. - mode: + attached_to: + description: Identifier of the interface to which this interface belongs, e.g. eth1.Only for virtual interfaces. required: false type: string + mode: description: Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. - identifier: required: false type: string - description: Device identifier, e.g. eth0 or eth1.1 - openscap_proxy_id: - required: false - type: number - description: ID of OpenSCAP Capsule - location_id: - required: false - type: number - description: required if locations are enabled - domain_id: - required: false - type: number - description: required if host is managed and value is not inherited from host group - compute_resource_id: - required: false - type: number - description: nil means host is bare metal - subnet_id: - required: false - type: number - description: required if host is managed and value is not inherited from host group - capabilities: - required: false - type: string - description: '' - architecture_id: - required: false - type: number - description: required if host is managed and value is not inherited from host group - build: - required: false - type: boolean - description: '' - host_parameters_attributes: - required: false - type: array - description: Host's parameters (array or indexed hash) - parameters: - name: + attached_devices: + description: Identifiers of attached interfaces, e.g. `['eth1','eth2']`. For bond interfaces those are the slaves. Only for bondand bridges interfaces. required: false - type: string - description: Name of the parameter - value: + type: array + bond_options: + description: Space separated options, e.g. miimon=100. Only for bond interfaces. required: false type: string - description: Parameter value - puppetclass_ids: - required: false - type: array - description: '' - owner_id: - required: false - type: number - description: '' - operatingsystem_id: - required: false - type: string - description: required if host is managed and value is not inherited from host group - root_pass: - required: false - type: string - description: required if host is managed and value is not inherited from host group ordefault password in settings - ansible_role_ids: - required: false - type: array - description: IDs of associated ansible roles - organization_id: - required: false - type: number - description: required if organizations are enabled - image_id: - required: false - type: number - description: '' - mac: - required: false - type: string - description: required for managed host that is bare metal, not required if it's avirtual machine - puppet_ca_proxy_id: - required: false - type: number - description: Puppet CA Capsule ID - puppet_proxy_id: - required: false - type: number - description: Puppet Capsule ID - ptable_id: - required: false - type: number - description: required if host is managed and custom partition has not been defined - progress_report_id: - required: false - type: string - description: UUID to track orchestration tasks status, GET/api/orchestration/:UUID/tasks - realm_id: - required: false - type: number - description: '' - name: - required: false - type: string - description: '' - medium_id: - required: false - type: string - description: required if not imaged based provisioning and host is managed and value isnot inherited from host group - enabled: - required: false - type: boolean - description: Include this host within Satellite reporting - hostgroup_id: - required: false - type: number - description: '' + compute_attributes: + description: Additional compute resource specific attributes for the interface. + required: false + type: object compute_attributes: - required: false - type: object description: Additional compute resource specific attributes. - owner_type: required: false - type: string - description: Host's owner type - pxe_loader: + type: object + content_facet_attributes: + description: Parameters for host's content_facet facet required: false - type: string - description: DHCP filename option (Grub2/PXELinux by default) + type: object + parameters: + content_view_id: + description: '' + required: false + type: number + lifecycle_environment_id: + description: '' + required: false + type: number + content_source_id: + description: '' + required: false + type: number + kickstart_repository_id: + description: Repository Id associated with the kickstart repo used for provisioning + required: false + type: number subscription_facet_attributes: + description: Parameters for host's subscription_facet facet required: false type: object - description: Parameters for host's subscription_facet facet parameters: + release_version: + description: Release version for this Host to use (7Server, 7.1, etc) + required: false + type: string + autoheal: + description: Sets whether the Host will autoheal subscriptions upon checkin + required: false + type: boolean purpose_usage: + description: Sets the system purpose usage required: false type: string + purpose_role: description: Sets the system purpose usage - installed_products_attributes: + required: false + type: string + purpose_addons: + description: Sets the system add-ons + required: false + type: array + service_level: + description: Service level to be used for autoheal + required: false + type: string + hypervisor_guest_uuids: + description: List of hypervisor guest uuids required: false type: array + installed_products_attributes: description: List of products installed on the host + required: false + type: array parameters: - version: + product_id: + description: Product id as listed from a host's installed products, this isnot the same product id as the products api returns required: false type: string - description: Product version - arch: + product_name: + description: Product name as listed from a host's installed products required: false type: string + arch: description: Product architecture - product_id: required: false type: string - description: Product id as listed from a host's installed products, this isnot the same product id as the products api returns - product_name: + version: + description: Product version required: false type: string - description: Product name as listed from a host's installed products - autoheal: - required: false - type: boolean - description: Sets whether the Host will autoheal subscriptions upon checkin - release_version: - required: false - type: string - description: Release version for this Host to use (7Server, 7.1, etc) - service_level: - required: false - type: string - description: Service level to be used for autoheal - purpose_role: - required: false - type: string - description: Sets the system purpose usage - purpose_addons: - required: false - type: array - description: Sets the system add-ons - hypervisor_guest_uuids: - required: false - type: array - description: List of hypervisor guest uuids - compute_profile_id: + ansible_role_ids: + description: IDs of associated ansible roles required: false - type: number - description: '' + type: array " \ No newline at end of file diff --git a/actions/hosts.vm_compute_attributes.yaml b/actions/hosts.vm_compute_attributes.yaml index e209e58..ec48d94 100644 --- a/actions/hosts.vm_compute_attributes.yaml +++ b/actions/hosts.vm_compute_attributes.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/http_proxies.create.yaml b/actions/http_proxies.create.yaml index ab8d196..2cfcc76 100644 --- a/actions/http_proxies.create.yaml +++ b/actions/http_proxies.create.yaml @@ -30,39 +30,39 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" http_proxy: type: object required: true description: > "description: parameters: - username: - required: false - type: string - description: Username used to authenticate with the HTTP Proxy name: + description: The HTTP Proxy name required: true type: string - description: The HTTP Proxy name url: + description: URL of the HTTP Proxy required: true type: string - description: URL of the HTTP Proxy - location_ids: + username: + description: Username used to authenticate with the HTTP Proxy required: false - type: array - description: REPLACE locations with given ids + type: string password: + description: Password used to authenticate with the HTTP Proxy required: false type: string - description: Password used to authenticate with the HTTP Proxy - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/http_proxies.destroy.yaml b/actions/http_proxies.destroy.yaml index cf98096..e325155 100644 --- a/actions/http_proxies.destroy.yaml +++ b/actions/http_proxies.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/http_proxies.index.yaml b/actions/http_proxies.index.yaml index eb6d33d..8362025 100644 --- a/actions/http_proxies.index.yaml +++ b/actions/http_proxies.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/http_proxies.show.yaml b/actions/http_proxies.show.yaml index 79e6c67..1353a57 100644 --- a/actions/http_proxies.show.yaml +++ b/actions/http_proxies.show.yaml @@ -30,12 +30,12 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true - description: "Numerical ID or HTTP Proxy name" \ No newline at end of file + description: "Identifier of the HTTP Proxy" \ No newline at end of file diff --git a/actions/http_proxies.update.yaml b/actions/http_proxies.update.yaml index 4ea095b..c1ae507 100644 --- a/actions/http_proxies.update.yaml +++ b/actions/http_proxies.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,28 +44,28 @@ parameters: description: > "description: parameters: - username: - required: false - type: string - description: Username used to authenticate with the HTTP Proxy name: + description: The HTTP Proxy name required: false type: string - description: The HTTP Proxy name url: + description: URL of the HTTP Proxy required: false type: string - description: URL of the HTTP Proxy - location_ids: + username: + description: Username used to authenticate with the HTTP Proxy required: false - type: array - description: REPLACE locations with given ids + type: string password: + description: Password used to authenticate with the HTTP Proxy required: false type: string - description: Password used to authenticate with the HTTP Proxy - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/job_invocations.cancel.yaml b/actions/job_invocations.cancel.yaml index ec0eb35..3ced40a 100644 --- a/actions/job_invocations.cancel.yaml +++ b/actions/job_invocations.cancel.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/job_invocations.create.yaml b/actions/job_invocations.create.yaml index 476f915..1cf7b9e 100644 --- a/actions/job_invocations.create.yaml +++ b/actions/job_invocations.create.yaml @@ -30,99 +30,103 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" job_invocation: type: object required: true description: > "description: parameters: - inputs: - required: false - type: object - description: Inputs to use - search_query: + job_template_id: + description: The job template to use, parameter is required unless feature was specified required: false type: string - description: '' - description_format: - required: false + targeting_type: + description: Invocation type, one of {'static_query'=>'Static Query','dynamic_query'=>'Dynamic Query'} + required: true type: string - description: Override the description format from the template for this invocation only - concurrency_control: + randomized_ordering: + description: Execute the jobs on hosts in randomized order + required: false + type: boolean + inputs: + description: Inputs to use + required: false + type: object + ssh: + description: SSH provider specific options required: false type: object - description: Control concurrency level and distribution over time parameters: - concurrency_level: - required: false - type: number - description: Run at most N tasks at a time - time_span: + effective_user: + description: What user should be used to run the script (using sudo-like mechanisms).Defaults to a template parameter or global setting. required: false - type: number - description: Distribute tasks over N seconds - feature: - required: false - type: string - description: Remote execution feature label that should be triggered, job templateassigned to this feature will be used - targeting_type: - required: true - type: string - description: Invocation type, one of {'static_query'=>'Static Query','dynamic_query'=>'Dynamic Query'} + type: string recurrence: + description: Create a recurring job required: false type: object - description: Create a recurring job parameters: cron_line: + description: How often the job should occur, in the cron format required: false type: string - description: How often the job should occur, in the cron format max_iteration: + description: Repeat a maximum of N times required: false type: number - description: Repeat a maximum of N times end_time: + description: Perform no more executions after this time required: false type: string - description: Perform no more executions after this time - execution_timeout_interval: - required: false - type: number - description: Override the timeout interval from the template for this invocation only - bookmark_id: - required: false - type: number - description: '' - job_template_id: - required: false - type: string - description: The job template to use, parameter is required unless feature was specified scheduling: + description: Schedule the job to start at a later time required: false type: object - description: Schedule the job to start at a later time parameters: - start_before: + start_at: + description: Schedule the job for a future time required: false type: string + start_before: description: Indicates that the action should be cancelled if it cannot be startedbefore this time. - start_at: required: false type: string - description: Schedule the job for a future time - ssh: + concurrency_control: + description: Control concurrency level and distribution over time required: false type: object - description: SSH provider specific options parameters: - effective_user: + time_span: + description: Distribute tasks over N seconds required: false - type: string - description: What user should be used to run the script (using sudo-like mechanisms).Defaults to a template parameter or global setting. + type: number + concurrency_level: + description: Run at most N tasks at a time + required: false + type: number + bookmark_id: + description: '' + required: false + type: number + search_query: + description: '' + required: false + type: string + description_format: + description: Override the description format from the template for this invocation only + required: false + type: string + execution_timeout_interval: + description: Override the timeout interval from the template for this invocation only + required: false + type: number + feature: + description: Remote execution feature label that should be triggered, job templateassigned to this feature will be used + required: false + type: string " \ No newline at end of file diff --git a/actions/job_invocations.id_outputhosts.yaml b/actions/job_invocations.id_outputhosts.yaml index 5ec414e..4d2a822 100644 --- a/actions/job_invocations.id_outputhosts.yaml +++ b/actions/job_invocations.id_outputhosts.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/job_invocations.id_raw_outputhosts.yaml b/actions/job_invocations.id_raw_outputhosts.yaml index 03c3751..8427e30 100644 --- a/actions/job_invocations.id_raw_outputhosts.yaml +++ b/actions/job_invocations.id_raw_outputhosts.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/job_invocations.index.yaml b/actions/job_invocations.index.yaml index 92ae06d..79d9d1d 100644 --- a/actions/job_invocations.index.yaml +++ b/actions/job_invocations.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/job_invocations.rerun.yaml b/actions/job_invocations.rerun.yaml index b78ffa2..b001ddb 100644 --- a/actions/job_invocations.rerun.yaml +++ b/actions/job_invocations.rerun.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/job_invocations.show.yaml b/actions/job_invocations.show.yaml index 971f2ad..31c8a4a 100644 --- a/actions/job_invocations.show.yaml +++ b/actions/job_invocations.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/job_invocations.template_invocations_template_invocations.yaml b/actions/job_invocations.template_invocations_template_invocations.yaml index 6faf5af..7338820 100644 --- a/actions/job_invocations.template_invocations_template_invocations.yaml +++ b/actions/job_invocations.template_invocations_template_invocations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,15 +42,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" job_invocation_id: type: string required: true \ No newline at end of file diff --git a/actions/job_templates.clone.yaml b/actions/job_templates.clone.yaml index 7eac559..f0f9ca4 100644 --- a/actions/job_templates.clone.yaml +++ b/actions/job_templates.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: Template name required: true type: string - description: Template name " \ No newline at end of file diff --git a/actions/job_templates.create.yaml b/actions/job_templates.create.yaml index 822f287..3dba3d4 100644 --- a/actions/job_templates.create.yaml +++ b/actions/job_templates.create.yaml @@ -30,72 +30,76 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" job_template: type: object required: true description: > "description: parameters: - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: Template name required: true type: string - description: Template name - description_format: + description: + description: '' required: false type: string + job_category: + description: Job category + required: true + type: string + description_format: description: This template is used to generate the description. Input values can be usedusing the syntax %{package}. You may also include the job category andtemplate name using %{job_category} and %{template_name}. + required: false + type: string + template: + description: '' + required: true + type: string + provider_type: + description: Provider type + required: true + type: string snippet: + description: '' required: false type: boolean + audit_comment: description: '' + required: false + type: string + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean effective_user_attributes: + description: Effective user options required: false type: object - description: Effective user options parameters: - overridable: - required: false - type: boolean - description: Whether it should be allowed to override the effective user from theinvocation form. value: + description: What user should be used to run the script (using sudo-like mechanisms) required: false type: string - description: What user should be used to run the script (using sudo-like mechanisms) - current_user: + overridable: + description: Whether it should be allowed to override the effective user from theinvocation form. required: false type: boolean + current_user: description: Whether the current user login should be used as the effective user - template: - required: true - type: string - description: '' - job_category: - required: true - type: string - description: Job category - audit_comment: - required: false - type: string - description: '' + required: false + type: boolean location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. - provider_type: - required: true - type: string - description: Provider type " \ No newline at end of file diff --git a/actions/job_templates.destroy.yaml b/actions/job_templates.destroy.yaml index 5dea661..654480c 100644 --- a/actions/job_templates.destroy.yaml +++ b/actions/job_templates.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/job_templates.export.yaml b/actions/job_templates.export.yaml index c0b14ff..dbac892 100644 --- a/actions/job_templates.export.yaml +++ b/actions/job_templates.export.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/job_templates.import_.yaml b/actions/job_templates.import_.yaml index 9af0e96..5912ab6 100644 --- a/actions/job_templates.import_.yaml +++ b/actions/job_templates.import_.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template: type: string required: true diff --git a/actions/job_templates.index.yaml b/actions/job_templates.index.yaml index fa0fb10..c5a1ba8 100644 --- a/actions/job_templates.index.yaml +++ b/actions/job_templates.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/job_templates.revision.yaml b/actions/job_templates.revision.yaml index 4d50c54..3e6e7c6 100644 --- a/actions/job_templates.revision.yaml +++ b/actions/job_templates.revision.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" version: type: string required: false diff --git a/actions/job_templates.show.yaml b/actions/job_templates.show.yaml index ae40e4a..54a8ae4 100644 --- a/actions/job_templates.show.yaml +++ b/actions/job_templates.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/job_templates.update.yaml b/actions/job_templates.update.yaml index d97f082..c91b30f 100644 --- a/actions/job_templates.update.yaml +++ b/actions/job_templates.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,61 +44,65 @@ parameters: description: > "description: parameters: - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: Template name required: false type: string - description: Template name - description_format: + description: + description: '' required: false type: string + job_category: + description: Job category + required: false + type: string + description_format: description: This template is used to generate the description. Input values can be usedusing the syntax %{package}. You may also include the job category andtemplate name using %{job_category} and %{template_name}. + required: false + type: string + template: + description: '' + required: false + type: string + provider_type: + description: Provider type + required: false + type: string snippet: + description: '' required: false type: boolean + audit_comment: description: '' + required: false + type: string + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean effective_user_attributes: + description: Effective user options required: false type: object - description: Effective user options parameters: - overridable: - required: false - type: boolean - description: Whether it should be allowed to override the effective user from theinvocation form. value: + description: What user should be used to run the script (using sudo-like mechanisms) required: false type: string - description: What user should be used to run the script (using sudo-like mechanisms) - current_user: + overridable: + description: Whether it should be allowed to override the effective user from theinvocation form. required: false type: boolean + current_user: description: Whether the current user login should be used as the effective user - template: - required: false - type: string - description: '' - job_category: - required: false - type: string - description: Job category - audit_comment: - required: false - type: string - description: '' + required: false + type: boolean location_ids: - required: false - type: array description: REPLACE locations with given ids - organization_ids: required: false type: array + organization_ids: description: REPLACE organizations with given ids. - provider_type: required: false - type: string - description: Provider type + type: array " \ No newline at end of file diff --git a/actions/locations.auth_source_externals_index.yaml b/actions/locations.auth_source_externals_index.yaml index 9b91abb..2f74511 100644 --- a/actions/locations.auth_source_externals_index.yaml +++ b/actions/locations.auth_source_externals_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.auth_source_ldaps_index.yaml b/actions/locations.auth_source_ldaps_index.yaml index a7ba399..497ceaf 100644 --- a/actions/locations.auth_source_ldaps_index.yaml +++ b/actions/locations.auth_source_ldaps_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.auth_sources_index.yaml b/actions/locations.auth_sources_index.yaml index 9e91344..ade6ec9 100644 --- a/actions/locations.auth_sources_index.yaml +++ b/actions/locations.auth_sources_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.config_templates_index.yaml b/actions/locations.config_templates_index.yaml index 139a3e1..be27d19 100644 --- a/actions/locations.config_templates_index.yaml +++ b/actions/locations.config_templates_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.create.yaml b/actions/locations.create.yaml index 483f8dd..2b579f6 100644 --- a/actions/locations.create.yaml +++ b/actions/locations.create.yaml @@ -30,79 +30,83 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" location: type: object required: true description: > "description: parameters: - realm_ids: - required: false - type: array - description: Realm IDs - subnet_ids: - required: false - type: array - description: Subnet IDs name: + description: '' required: true type: string + description: description: '' - config_template_ids: + required: false + type: string + user_ids: + description: User IDs required: false type: array - description: Provisioning template IDs - description: + smart_proxy_ids: + description: Smart proxy IDs required: false - type: string - description: '' - domain_ids: + type: array + compute_resource_ids: + description: Compute resource IDs required: false type: array - description: Domain IDs - hostgroup_ids: + medium_ids: + description: Medium IDs required: false type: array - description: Host group IDs - ignore_types: + config_template_ids: + description: Provisioning template IDs required: false type: array - description: List of resources types that will be automatically associated - parent_id: + ptable_ids: + description: Partition template IDs required: false - type: number - description: Parent ID - user_ids: + type: array + provisioning_template_ids: + description: Provisioning template IDs required: false type: array - description: User IDs - medium_ids: + domain_ids: + description: Domain IDs required: false type: array - description: Medium IDs - smart_proxy_ids: + realm_ids: + description: Realm IDs required: false type: array - description: Capsule IDs - environment_ids: + hostgroup_ids: + description: Host group IDs required: false type: array + environment_ids: description: Environment IDs - ptable_ids: required: false type: array - description: Partition template IDs - provisioning_template_ids: + subnet_ids: + description: Subnet IDs required: false type: array - description: Provisioning template IDs - compute_resource_ids: + parent_id: + description: Parent ID + required: false + type: number + ignore_types: + description: List of resources types that will be automatically associated + required: false + type: array + organization_ids: + description: Associated organization IDs required: false type: array - description: Compute resource IDs " \ No newline at end of file diff --git a/actions/locations.destroy.yaml b/actions/locations.destroy.yaml index 60cd0c7..77b7c74 100644 --- a/actions/locations.destroy.yaml +++ b/actions/locations.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/locations.domains_index.yaml b/actions/locations.domains_index.yaml index 8a59888..259d591 100644 --- a/actions/locations.domains_index.yaml +++ b/actions/locations.domains_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.environments_index.yaml b/actions/locations.environments_index.yaml index 46d70d7..cc9295f 100644 --- a/actions/locations.environments_index.yaml +++ b/actions/locations.environments_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.hostgroups_index.yaml b/actions/locations.hostgroups_index.yaml index 42b31eb..d49ccfe 100644 --- a/actions/locations.hostgroups_index.yaml +++ b/actions/locations.hostgroups_index.yaml @@ -46,15 +46,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" include: type: array required: false diff --git a/actions/locations.hosts_index.yaml b/actions/locations.hosts_index.yaml index 1308468..58060e8 100644 --- a/actions/locations.hosts_index.yaml +++ b/actions/locations.hosts_index.yaml @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.index.yaml b/actions/locations.index.yaml index fd1ce8c..47225bd 100644 --- a/actions/locations.index.yaml +++ b/actions/locations.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.job_templates_index.yaml b/actions/locations.job_templates_index.yaml index 98e37bd..65eb185 100644 --- a/actions/locations.job_templates_index.yaml +++ b/actions/locations.job_templates_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.media_index.yaml b/actions/locations.media_index.yaml index e57d9ab..bd4aa64 100644 --- a/actions/locations.media_index.yaml +++ b/actions/locations.media_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.parameters_create.yaml b/actions/locations.parameters_create.yaml index d7a7bdd..66ab9ed 100644 --- a/actions/locations.parameters_create.yaml +++ b/actions/locations.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/locations.parameters_index.yaml b/actions/locations.parameters_index.yaml index 0e125c4..34a12f5 100644 --- a/actions/locations.parameters_index.yaml +++ b/actions/locations.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.parameters_location_id_updateparameters.yaml b/actions/locations.parameters_location_id_updateparameters.yaml index fdac871..470e4f6 100644 --- a/actions/locations.parameters_location_id_updateparameters.yaml +++ b/actions/locations.parameters_location_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/locations.provisioning_templates_index.yaml b/actions/locations.provisioning_templates_index.yaml index 4857612..3e69553 100644 --- a/actions/locations.provisioning_templates_index.yaml +++ b/actions/locations.provisioning_templates_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.ptables_index.yaml b/actions/locations.ptables_index.yaml index e55370a..90d892f 100644 --- a/actions/locations.ptables_index.yaml +++ b/actions/locations.ptables_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.report_templates_index.yaml b/actions/locations.report_templates_index.yaml index bb75ca7..cda2fe8 100644 --- a/actions/locations.report_templates_index.yaml +++ b/actions/locations.report_templates_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.show.yaml b/actions/locations.show.yaml index 0963df4..0340259 100644 --- a/actions/locations.show.yaml +++ b/actions/locations.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" show_hidden_parameters: type: boolean required: false diff --git a/actions/locations.subnets_index.yaml b/actions/locations.subnets_index.yaml index 27bee88..578aced 100644 --- a/actions/locations.subnets_index.yaml +++ b/actions/locations.subnets_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/locations.update.yaml b/actions/locations.update.yaml index 3d1ce15..208b874 100644 --- a/actions/locations.update.yaml +++ b/actions/locations.update.yaml @@ -30,81 +30,85 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" location: type: object required: true description: > "description: parameters: - realm_ids: - required: false - type: array - description: Realm IDs - subnet_ids: - required: false - type: array - description: Subnet IDs name: + description: '' required: false type: string + description: description: '' - config_template_ids: + required: false + type: string + user_ids: + description: User IDs required: false type: array - description: Provisioning template IDs - description: + smart_proxy_ids: + description: Smart proxy IDs required: false - type: string - description: '' - domain_ids: + type: array + compute_resource_ids: + description: Compute resource IDs required: false type: array - description: Domain IDs - hostgroup_ids: + medium_ids: + description: Medium IDs required: false type: array - description: Host group IDs - ignore_types: + config_template_ids: + description: Provisioning template IDs required: false type: array - description: List of resources types that will be automatically associated - parent_id: + ptable_ids: + description: Partition template IDs required: false - type: number - description: Parent ID - user_ids: + type: array + provisioning_template_ids: + description: Provisioning template IDs required: false type: array - description: User IDs - medium_ids: + domain_ids: + description: Domain IDs required: false type: array - description: Medium IDs - smart_proxy_ids: + realm_ids: + description: Realm IDs required: false type: array - description: Capsule IDs - environment_ids: + hostgroup_ids: + description: Host group IDs required: false type: array + environment_ids: description: Environment IDs - ptable_ids: required: false type: array - description: Partition template IDs - provisioning_template_ids: + subnet_ids: + description: Subnet IDs required: false type: array - description: Provisioning template IDs - compute_resource_ids: + parent_id: + description: Parent ID + required: false + type: number + ignore_types: + description: List of resources types that will be automatically associated + required: false + type: array + organization_ids: + description: Associated organization IDs required: false type: array - description: Compute resource IDs " id: type: string diff --git a/actions/locations.users_index.yaml b/actions/locations.users_index.yaml index 8d09c70..6e4b0fd 100644 --- a/actions/locations.users_index.yaml +++ b/actions/locations.users_index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/mail_notifications.index.yaml b/actions/mail_notifications.index.yaml index 6a9b825..b7698a5 100644 --- a/actions/mail_notifications.index.yaml +++ b/actions/mail_notifications.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/mail_notifications.show.yaml b/actions/mail_notifications.show.yaml index 81a9f05..896baf3 100644 --- a/actions/mail_notifications.show.yaml +++ b/actions/mail_notifications.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/media.create.yaml b/actions/media.create.yaml index 5514c17..9ec9820 100644 --- a/actions/media.create.yaml +++ b/actions/media.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" medium: type: object required: true @@ -42,27 +42,27 @@ parameters: "description: parameters: name: + description: Name of media + required: true + type: string + path: + description: The path to the medium, can be a URL or a valid NFS server (exclusive ofthe architecture).for example mirror.centos.org/centos/$version/os/$archwhere $arch will be substituted for the host's actual OS architectureand $version, $major and $minor will be substituted for the version of theoperating system.Solaris and Debian media may also use $release. required: true type: string - description: Name of media os_family: + description: 'Operating system family, available values: AIX, Altlinux, Archlinux,Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,Suse, VRP, Windows, Xenserver' required: false type: string - description: 'Operating system family, available values: AIX, Altlinux, Archlinux,Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,Suse, Windows, Xenserver' operatingsystem_ids: + description: '' required: false type: array - description: '' - path: - required: true - type: string - description: The path to the medium, can be a URL or a valid NFS server (exclusive ofthe architecture).for example mirror.centos.org/centos/$version/os/$archwhere $arch will be substituted for the host's actual OS architectureand $version, $major and $minor will be substituted for the version of theoperating system.Solaris and Debian media may also use $release. location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/media.destroy.yaml b/actions/media.destroy.yaml index 63d0424..badbd2d 100644 --- a/actions/media.destroy.yaml +++ b/actions/media.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/media.index.yaml b/actions/media.index.yaml index 962c8b0..ae355ea 100644 --- a/actions/media.index.yaml +++ b/actions/media.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/media.operatingsystems_index.yaml b/actions/media.operatingsystems_index.yaml index b0d7e79..fed70b1 100644 --- a/actions/media.operatingsystems_index.yaml +++ b/actions/media.operatingsystems_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture_id: type: string required: false @@ -62,13 +62,13 @@ parameters: "description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value " search: type: string @@ -77,12 +77,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/media.show.yaml b/actions/media.show.yaml index 190c836..c0a5d42 100644 --- a/actions/media.show.yaml +++ b/actions/media.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/media.update.yaml b/actions/media.update.yaml index 24bb127..f23beb1 100644 --- a/actions/media.update.yaml +++ b/actions/media.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,27 +45,27 @@ parameters: "description: parameters: name: + description: Name of media + required: false + type: string + path: + description: The path to the medium, can be a URL or a valid NFS server (exclusive ofthe architecture).for example mirror.centos.org/centos/$version/os/$archwhere $arch will be substituted for the host's actual OS architectureand $version, $major and $minor will be substituted for the version of theoperating system.Solaris and Debian media may also use $release. required: false type: string - description: Name of media os_family: + description: 'Operating system family, available values: AIX, Altlinux, Archlinux,Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,Suse, VRP, Windows, Xenserver' required: false type: string - description: 'Operating system family, available values: AIX, Altlinux, Archlinux,Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,Suse, Windows, Xenserver' operatingsystem_ids: - required: false - type: array description: '' - path: required: false - type: string - description: The path to the medium, can be a URL or a valid NFS server (exclusive ofthe architecture).for example mirror.centos.org/centos/$version/os/$archwhere $arch will be substituted for the host's actual OS architectureand $version, $major and $minor will be substituted for the version of theoperating system.Solaris and Debian media may also use $release. + type: array location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/models.create.yaml b/actions/models.create.yaml index 5fc1d45..96f704b 100644 --- a/actions/models.create.yaml +++ b/actions/models.create.yaml @@ -30,31 +30,31 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" model: type: object required: true description: > "description: parameters: - info: - required: false + name: + description: '' + required: true type: string + info: description: '' - hardware_model: required: false type: string - description: '' vendor_class: + description: '' required: false type: string + hardware_model: description: '' - name: - required: true + required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/models.destroy.yaml b/actions/models.destroy.yaml index 5928d17..ad2b7d9 100644 --- a/actions/models.destroy.yaml +++ b/actions/models.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/models.index.yaml b/actions/models.index.yaml index 5eb7446..edaf706 100644 --- a/actions/models.index.yaml +++ b/actions/models.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/models.show.yaml b/actions/models.show.yaml index ec87da4..303e8de 100644 --- a/actions/models.show.yaml +++ b/actions/models.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/models.update.yaml b/actions/models.update.yaml index 7d17709..a02b7f2 100644 --- a/actions/models.update.yaml +++ b/actions/models.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,20 +44,20 @@ parameters: description: > "description: parameters: - info: + name: + description: '' required: false type: string + info: description: '' - hardware_model: required: false type: string - description: '' vendor_class: + description: '' required: false type: string + hardware_model: description: '' - name: required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/module_streams.index.yaml b/actions/module_streams.index.yaml index cc6485f..f658458 100644 --- a/actions/module_streams.index.yaml +++ b/actions/module_streams.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/operatingsystems.architectures_index.yaml b/actions/operatingsystems.architectures_index.yaml index da80f61..6bfb139 100644 --- a/actions/operatingsystems.architectures_index.yaml +++ b/actions/operatingsystems.architectures_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,15 +42,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" operatingsystem_id: type: string required: true diff --git a/actions/operatingsystems.bootfiles.yaml b/actions/operatingsystems.bootfiles.yaml index 2507057..76bbf3a 100644 --- a/actions/operatingsystems.bootfiles.yaml +++ b/actions/operatingsystems.bootfiles.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/operatingsystems.config_templates_index.yaml b/actions/operatingsystems.config_templates_index.yaml index 2ea2490..0bbd702 100644 --- a/actions/operatingsystems.config_templates_index.yaml +++ b/actions/operatingsystems.config_templates_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.create.yaml b/actions/operatingsystems.create.yaml index f4d6c4d..db94b3a 100644 --- a/actions/operatingsystems.create.yaml +++ b/actions/operatingsystems.create.yaml @@ -30,76 +30,76 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem: type: object required: true description: > "description: parameters: - major: + name: + description: '' required: true type: string + major: description: '' - name: required: true type: string + minor: description: '' - family: required: false type: string + description: description: '' - config_template_ids: required: false - type: array - description: IDs of associated provisioning templates - architecture_ids: + type: string + family: + description: '' required: false - type: array - description: IDs of associated architectures + type: string + release_name: + description: '' + required: false + type: string os_parameters_attributes: + description: Array of parameters required: false type: array - description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value - medium_ids: + password_hash: + description: Root password hash function to use required: false - type: array - description: IDs of associated media - provisioning_template_ids: + type: string + architecture_ids: + description: IDs of associated architectures required: false type: array + config_template_ids: description: IDs of associated provisioning templates - password_hash: required: false - type: string - description: Root password hash function to use, one of MD5, SHA256, SHA512, Base64 - release_name: + type: array + provisioning_template_ids: + description: IDs of associated provisioning templates required: false - type: string - description: '' - ptable_ids: + type: array + medium_ids: + description: IDs of associated media required: false type: array + ptable_ids: description: IDs of associated partition tables - minor: required: false - type: string - description: '' - description: - required: false - type: string - description: '' + type: array " \ No newline at end of file diff --git a/actions/operatingsystems.destroy.yaml b/actions/operatingsystems.destroy.yaml index f97e0f3..da4c39c 100644 --- a/actions/operatingsystems.destroy.yaml +++ b/actions/operatingsystems.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/operatingsystems.images_index.yaml b/actions/operatingsystems.images_index.yaml index 30bf630..bb56b84 100644 --- a/actions/operatingsystems.images_index.yaml +++ b/actions/operatingsystems.images_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" compute_resource_id: type: string required: false @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.images_operatingsystem_id_showimages.yaml b/actions/operatingsystems.images_operatingsystem_id_showimages.yaml index 9951b40..be3475b 100644 --- a/actions/operatingsystems.images_operatingsystem_id_showimages.yaml +++ b/actions/operatingsystems.images_operatingsystem_id_showimages.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/operatingsystems.index.yaml b/actions/operatingsystems.index.yaml index 98d005d..983d38d 100644 --- a/actions/operatingsystems.index.yaml +++ b/actions/operatingsystems.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture_id: type: string required: false @@ -62,13 +62,13 @@ parameters: "description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value " search: type: string @@ -77,12 +77,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.media_index.yaml b/actions/operatingsystems.media_index.yaml index 3228957..61ab45c 100644 --- a/actions/operatingsystems.media_index.yaml +++ b/actions/operatingsystems.media_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.os_default_templates_create.yaml b/actions/operatingsystems.os_default_templates_create.yaml index 215b5af..3f77d97 100644 --- a/actions/operatingsystems.os_default_templates_create.yaml +++ b/actions/operatingsystems.os_default_templates_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: true @@ -46,15 +46,15 @@ parameters: "description: parameters: template_kind_id: - required: false - type: number description: '' - provisioning_template_id: required: false type: number - description: ID of provisioning template config_template_id: + description: ID of provisioning template required: false type: number + provisioning_template_id: description: ID of provisioning template + required: false + type: number " \ No newline at end of file diff --git a/actions/operatingsystems.os_default_templates_index.yaml b/actions/operatingsystems.os_default_templates_index.yaml index 488a561..942aa97 100644 --- a/actions/operatingsystems.os_default_templates_index.yaml +++ b/actions/operatingsystems.os_default_templates_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: true @@ -48,10 +48,10 @@ parameters: required: false description: "ID of provisioning template" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_destroytemplates.yaml b/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_destroytemplates.yaml index 0cd09da..8d4770a 100644 --- a/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_destroytemplates.yaml +++ b/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_destroytemplates.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: true diff --git a/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_showtemplates.yaml b/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_showtemplates.yaml index 1eef3f7..8b170c5 100644 --- a/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_showtemplates.yaml +++ b/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_showtemplates.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: true diff --git a/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_updatetemplates.yaml b/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_updatetemplates.yaml index 99214e7..45f8335 100644 --- a/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_updatetemplates.yaml +++ b/actions/operatingsystems.os_default_templates_operatingsystem_id_os_default_updatetemplates.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: true @@ -49,15 +49,15 @@ parameters: "description: parameters: template_kind_id: - required: false - type: number description: '' - provisioning_template_id: required: false type: number - description: ID of provisioning template config_template_id: + description: ID of provisioning template required: false type: number + provisioning_template_id: description: ID of provisioning template + required: false + type: number " \ No newline at end of file diff --git a/actions/operatingsystems.parameters_create.yaml b/actions/operatingsystems.parameters_create.yaml index 5948e5c..63d827a 100644 --- a/actions/operatingsystems.parameters_create.yaml +++ b/actions/operatingsystems.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/operatingsystems.parameters_index.yaml b/actions/operatingsystems.parameters_index.yaml index b59a491..6269c2d 100644 --- a/actions/operatingsystems.parameters_index.yaml +++ b/actions/operatingsystems.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.parameters_operatingsystem_id_updateparameters.yaml b/actions/operatingsystems.parameters_operatingsystem_id_updateparameters.yaml index 1383fb8..5979e8c 100644 --- a/actions/operatingsystems.parameters_operatingsystem_id_updateparameters.yaml +++ b/actions/operatingsystems.parameters_operatingsystem_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/operatingsystems.provisioning_templates_index.yaml b/actions/operatingsystems.provisioning_templates_index.yaml index 6b040af..ffc40b3 100644 --- a/actions/operatingsystems.provisioning_templates_index.yaml +++ b/actions/operatingsystems.provisioning_templates_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.ptables_index.yaml b/actions/operatingsystems.ptables_index.yaml index 6a9bd8b..a256fd7 100644 --- a/actions/operatingsystems.ptables_index.yaml +++ b/actions/operatingsystems.ptables_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/operatingsystems.show.yaml b/actions/operatingsystems.show.yaml index b0d271c..01abba7 100644 --- a/actions/operatingsystems.show.yaml +++ b/actions/operatingsystems.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/operatingsystems.update.yaml b/actions/operatingsystems.update.yaml index 6d9fe69..57b0586 100644 --- a/actions/operatingsystems.update.yaml +++ b/actions/operatingsystems.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,65 +44,65 @@ parameters: description: > "description: parameters: + name: + description: '' + required: false + type: string major: + description: '' required: false type: string + minor: description: '' - name: required: false type: string + description: description: '' - family: required: false type: string + family: description: '' - config_template_ids: required: false - type: array - description: IDs of associated provisioning templates - architecture_ids: + type: string + release_name: + description: '' required: false - type: array - description: IDs of associated architectures + type: string os_parameters_attributes: + description: Array of parameters required: false type: array - description: Array of parameters parameters: name: + description: Name of the parameter required: false type: string - description: Name of the parameter value: + description: Parameter value required: false type: string - description: Parameter value - medium_ids: + password_hash: + description: Root password hash function to use required: false - type: array - description: IDs of associated media - provisioning_template_ids: + type: string + architecture_ids: + description: IDs of associated architectures required: false type: array + config_template_ids: description: IDs of associated provisioning templates - password_hash: required: false - type: string - description: Root password hash function to use, one of MD5, SHA256, SHA512, Base64 - release_name: + type: array + provisioning_template_ids: + description: IDs of associated provisioning templates required: false - type: string - description: '' - ptable_ids: + type: array + medium_ids: + description: IDs of associated media required: false type: array + ptable_ids: description: IDs of associated partition tables - minor: required: false - type: string - description: '' - description: - required: false - type: string - description: '' + type: array " \ No newline at end of file diff --git a/actions/orchestration.tasks_index.yaml b/actions/orchestration.tasks_index.yaml index 8ba1b3a..c193b9b 100644 --- a/actions/orchestration.tasks_index.yaml +++ b/actions/orchestration.tasks_index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/organizations.auth_source_externals_index.yaml b/actions/organizations.auth_source_externals_index.yaml index 175c4df..121b4d3 100644 --- a/actions/organizations.auth_source_externals_index.yaml +++ b/actions/organizations.auth_source_externals_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.auth_source_ldaps_index.yaml b/actions/organizations.auth_source_ldaps_index.yaml index e2e7fff..ed464ce 100644 --- a/actions/organizations.auth_source_ldaps_index.yaml +++ b/actions/organizations.auth_source_ldaps_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.auth_sources_index.yaml b/actions/organizations.auth_sources_index.yaml index eaed282..2e6798b 100644 --- a/actions/organizations.auth_sources_index.yaml +++ b/actions/organizations.auth_sources_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.autoattach_subscriptions.yaml b/actions/organizations.autoattach_subscriptions.yaml index 0fe0cad..c2867db 100644 --- a/actions/organizations.autoattach_subscriptions.yaml +++ b/actions/organizations.autoattach_subscriptions.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/organizations.cancel_repo_discover.yaml b/actions/organizations.cancel_repo_discover.yaml index b1ac6ee..fb1b6c7 100644 --- a/actions/organizations.cancel_repo_discover.yaml +++ b/actions/organizations.cancel_repo_discover.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" label: type: string required: true diff --git a/actions/organizations.config_templates_index.yaml b/actions/organizations.config_templates_index.yaml index c13ff2b..e94a358 100644 --- a/actions/organizations.config_templates_index.yaml +++ b/actions/organizations.config_templates_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.content_views_create.yaml b/actions/organizations.content_views_create.yaml index a96ce4c..420223e 100644 --- a/actions/organizations.content_views_create.yaml +++ b/actions/organizations.content_views_create.yaml @@ -58,4 +58,8 @@ parameters: auto_publish: type: boolean required: false - description: "Enable/Disable auto publish of composite view" \ No newline at end of file + description: "Enable/Disable auto publish of composite view" + solve_dependencies: + type: boolean + required: false + description: "Solve RPM dependencies by default on Content View publish, defaults tofalse" \ No newline at end of file diff --git a/actions/organizations.create.yaml b/actions/organizations.create.yaml index fca6c03..c802b71 100644 --- a/actions/organizations.create.yaml +++ b/actions/organizations.create.yaml @@ -30,87 +30,75 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" - name: - type: string - required: true - description: "name" - label: - type: string - required: false - description: "unique label" - description: - type: string - required: false - description: "description" + description: "Set the current organization context for the request" organization: type: object required: true description: > "description: parameters: - realm_ids: - required: false - type: array - description: Realm IDs - subnet_ids: - required: false - type: array - description: Subnet IDs name: + description: '' required: true type: string - description: '' - config_template_ids: - required: false - type: array - description: Provisioning template IDs description: - required: false - type: string description: '' - domain_ids: - required: false - type: array - description: Domain IDs - label: required: false type: string - description: '' - hostgroup_ids: + user_ids: + description: User IDs required: false type: array - description: Host group IDs - user_ids: + smart_proxy_ids: + description: Smart proxy IDs required: false type: array - description: User IDs - medium_ids: + compute_resource_ids: + description: Compute resource IDs required: false type: array + medium_ids: description: Medium IDs - smart_proxy_ids: required: false type: array - description: Capsule IDs - environment_ids: + config_template_ids: + description: Provisioning template IDs required: false type: array - description: Environment IDs ptable_ids: + description: Partition template IDs required: false type: array - description: Partition template IDs provisioning_template_ids: + description: Provisioning template IDs required: false type: array - description: Provisioning template IDs - compute_resource_ids: + domain_ids: + description: Domain IDs required: false type: array - description: Compute resource IDs + realm_ids: + description: Realm IDs + required: false + type: array + hostgroup_ids: + description: Host group IDs + required: false + type: array + environment_ids: + description: Environment IDs + required: false + type: array + subnet_ids: + description: Subnet IDs + required: false + type: array + label: + description: '' + required: false + type: string " \ No newline at end of file diff --git a/actions/organizations.destroy.yaml b/actions/organizations.destroy.yaml index 1ba7e31..fb552ee 100644 --- a/actions/organizations.destroy.yaml +++ b/actions/organizations.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: number required: true diff --git a/actions/organizations.domains_index.yaml b/actions/organizations.domains_index.yaml index 04397a3..27d5f28 100644 --- a/actions/organizations.domains_index.yaml +++ b/actions/organizations.domains_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.download_debug_certificate.yaml b/actions/organizations.download_debug_certificate.yaml index 7e2b4fc..2463d80 100644 --- a/actions/organizations.download_debug_certificate.yaml +++ b/actions/organizations.download_debug_certificate.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" label: type: string required: true diff --git a/actions/organizations.environments_index.yaml b/actions/organizations.environments_index.yaml index 8ccb8cb..54a95b6 100644 --- a/actions/organizations.environments_index.yaml +++ b/actions/organizations.environments_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.hostgroups_index.yaml b/actions/organizations.hostgroups_index.yaml index 551b236..cf938ed 100644 --- a/actions/organizations.hostgroups_index.yaml +++ b/actions/organizations.hostgroups_index.yaml @@ -46,15 +46,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" include: type: array required: false diff --git a/actions/organizations.hosts_index.yaml b/actions/organizations.hosts_index.yaml index 3be22aa..fe1ffd2 100644 --- a/actions/organizations.hosts_index.yaml +++ b/actions/organizations.hosts_index.yaml @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.index.yaml b/actions/organizations.index.yaml index d28ec20..58f0e0e 100644 --- a/actions/organizations.index.yaml +++ b/actions/organizations.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false diff --git a/actions/organizations.job_templates_index.yaml b/actions/organizations.job_templates_index.yaml index 4eecfbe..58dd362 100644 --- a/actions/organizations.job_templates_index.yaml +++ b/actions/organizations.job_templates_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.media_index.yaml b/actions/organizations.media_index.yaml index fc81bc8..26d2d08 100644 --- a/actions/organizations.media_index.yaml +++ b/actions/organizations.media_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.parameters_create.yaml b/actions/organizations.parameters_create.yaml index a7bff72..86c44bb 100644 --- a/actions/organizations.parameters_create.yaml +++ b/actions/organizations.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/organizations.parameters_index.yaml b/actions/organizations.parameters_index.yaml index f107c50..690b687 100644 --- a/actions/organizations.parameters_index.yaml +++ b/actions/organizations.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.parameters_organization_id_updateparameters.yaml b/actions/organizations.parameters_organization_id_updateparameters.yaml index 8b1a6d1..80a8d6d 100644 --- a/actions/organizations.parameters_organization_id_updateparameters.yaml +++ b/actions/organizations.parameters_organization_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/organizations.provisioning_templates_index.yaml b/actions/organizations.provisioning_templates_index.yaml index 89daa30..1c828df 100644 --- a/actions/organizations.provisioning_templates_index.yaml +++ b/actions/organizations.provisioning_templates_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.ptables_index.yaml b/actions/organizations.ptables_index.yaml index 2b055bf..d501575 100644 --- a/actions/organizations.ptables_index.yaml +++ b/actions/organizations.ptables_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.redhat_provider.yaml b/actions/organizations.redhat_provider.yaml index 374d04f..d5a5630 100644 --- a/actions/organizations.redhat_provider.yaml +++ b/actions/organizations.redhat_provider.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/organizations.releases.yaml b/actions/organizations.releases.yaml index bdaf202..73da2fe 100644 --- a/actions/organizations.releases.yaml +++ b/actions/organizations.releases.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/organizations.repo_discover.yaml b/actions/organizations.repo_discover.yaml index b479be2..5fa6a0c 100644 --- a/actions/organizations.repo_discover.yaml +++ b/actions/organizations.repo_discover.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: number required: true diff --git a/actions/organizations.report_templates_index.yaml b/actions/organizations.report_templates_index.yaml index 8c4adbc..3efc9ea 100644 --- a/actions/organizations.report_templates_index.yaml +++ b/actions/organizations.report_templates_index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.repositories_index.yaml b/actions/organizations.repositories_index.yaml index acc3553..92dc9c4 100644 --- a/actions/organizations.repositories_index.yaml +++ b/actions/organizations.repositories_index.yaml @@ -63,6 +63,10 @@ parameters: type: string required: false description: "Id of a file to find repositories that contain the file" + ansible_collection_id: + type: string + required: false + description: "Id of an ansible collection to find repositories that contain the ansiblecollection" ostree_branch_id: type: string required: false @@ -71,6 +75,10 @@ parameters: type: boolean required: false description: "show repositories in Library and the default content view" + archived: + type: boolean + required: false + description: "show archived repositories" content_type: type: string required: false @@ -91,6 +99,10 @@ parameters: type: string required: false description: "interpret specified object to return only Repositories that can beassociated with specified object. Only 'content_view' &'content_view_version' are supported." + with_content: + type: string + required: false + description: "only repositories having at least one of the specified content type ex: rpm, erratum" search: type: string required: false diff --git a/actions/organizations.repositories_rganizations.yaml b/actions/organizations.repositories_rganizations.yaml index 21b3c6c..69e6911 100644 --- a/actions/organizations.repositories_rganizations.yaml +++ b/actions/organizations.repositories_rganizations.yaml @@ -63,6 +63,10 @@ parameters: type: string required: false description: "Id of a file to find repositories that contain the file" + ansible_collection_id: + type: string + required: false + description: "Id of an ansible collection to find repositories that contain the ansiblecollection" ostree_branch_id: type: string required: false @@ -71,6 +75,10 @@ parameters: type: boolean required: false description: "show repositories in Library and the default content view" + archived: + type: boolean + required: false + description: "show archived repositories" content_type: type: string required: false @@ -91,6 +99,10 @@ parameters: type: string required: false description: "interpret specified object to return only Repositories that can beassociated with specified object. Only 'content_view' &'content_view_version' are supported." + with_content: + type: string + required: false + description: "only repositories having at least one of the specified content type ex: rpm, erratum" search: type: string required: false diff --git a/actions/organizations.show.yaml b/actions/organizations.show.yaml index 99adeb4..c2657a0 100644 --- a/actions/organizations.show.yaml +++ b/actions/organizations.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: number required: true diff --git a/actions/organizations.subnets_index.yaml b/actions/organizations.subnets_index.yaml index 9e3373c..d1379b3 100644 --- a/actions/organizations.subnets_index.yaml +++ b/actions/organizations.subnets_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/organizations.sync_plans_create.yaml b/actions/organizations.sync_plans_create.yaml index 48c335a..3e67bed 100644 --- a/actions/organizations.sync_plans_create.yaml +++ b/actions/organizations.sync_plans_create.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: true - description: "Filter sync plans by organization name or label" + description: "Organization ID" name: type: string required: true diff --git a/actions/organizations.sync_plans_index.yaml b/actions/organizations.sync_plans_index.yaml index 962578a..21a3e01 100644 --- a/actions/organizations.sync_plans_index.yaml +++ b/actions/organizations.sync_plans_index.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: true - description: "Filter sync plans by organization name or label" + description: "Organization ID" name: type: string required: false diff --git a/actions/organizations.sync_plans_rganizations.yaml b/actions/organizations.sync_plans_rganizations.yaml index 39116a2..1bd7f44 100644 --- a/actions/organizations.sync_plans_rganizations.yaml +++ b/actions/organizations.sync_plans_rganizations.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: true - description: "Filter sync plans by organization name or label" + description: "Organization ID" id: type: number required: true diff --git a/actions/organizations.update.yaml b/actions/organizations.update.yaml index f4a695e..8dcd5b3 100644 --- a/actions/organizations.update.yaml +++ b/actions/organizations.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: number required: true @@ -49,68 +49,72 @@ parameters: description: > "description: parameters: - realm_ids: - required: false - type: array - description: Realm IDs - subnet_ids: - required: false - type: array - description: Subnet IDs name: + description: '' required: false type: string + description: description: '' - config_template_ids: + required: false + type: string + user_ids: + description: User IDs required: false type: array - description: Provisioning template IDs - description: + smart_proxy_ids: + description: Smart proxy IDs required: false - type: string - description: '' - domain_ids: + type: array + compute_resource_ids: + description: Compute resource IDs required: false type: array - description: Domain IDs - hostgroup_ids: + medium_ids: + description: Medium IDs required: false type: array - description: Host group IDs - ignore_types: + config_template_ids: + description: Provisioning template IDs required: false type: array - description: List of resources types that will be automatically associated - parent_id: + ptable_ids: + description: Partition template IDs required: false - type: number - description: Parent ID - user_ids: + type: array + provisioning_template_ids: + description: Provisioning template IDs required: false type: array - description: User IDs - medium_ids: + domain_ids: + description: Domain IDs required: false type: array - description: Medium IDs - smart_proxy_ids: + realm_ids: + description: Realm IDs required: false type: array - description: Capsule IDs - environment_ids: + hostgroup_ids: + description: Host group IDs required: false type: array + environment_ids: description: Environment IDs - ptable_ids: required: false type: array - description: Partition template IDs - provisioning_template_ids: + subnet_ids: + description: Subnet IDs required: false type: array - description: Provisioning template IDs - compute_resource_ids: + parent_id: + description: Parent ID + required: false + type: number + ignore_types: + description: List of resources types that will be automatically associated + required: false + type: array + location_ids: + description: Associated location IDs required: false type: array - description: Compute resource IDs " \ No newline at end of file diff --git a/actions/organizations.upstream_subscriptions_create.yaml b/actions/organizations.upstream_subscriptions_create.yaml index c8878ed..a590cdc 100644 --- a/actions/organizations.upstream_subscriptions_create.yaml +++ b/actions/organizations.upstream_subscriptions_create.yaml @@ -34,13 +34,13 @@ parameters: "description: Array of pools to add parameters: id: + description: Candlepin ID of pool to add required: true type: string - description: Candlepin ID of pool to add quantity: + description: Quantity of entitlements to bind required: true type: number - description: Quantity of entitlements to bind " organization_id: type: number diff --git a/actions/organizations.upstream_subscriptions_index.yaml b/actions/organizations.upstream_subscriptions_index.yaml index 42a00af..01e902a 100644 --- a/actions/organizations.upstream_subscriptions_index.yaml +++ b/actions/organizations.upstream_subscriptions_index.yaml @@ -50,7 +50,7 @@ parameters: pool_ids: type: array required: false - description: "Return only the upstream pools which map to the given Katello pool IDs" + description: "Return only the upstream pools which map to the given orcharhino pool IDs" quantities_only: type: boolean required: false diff --git a/actions/organizations.upstream_subscriptions_update.yaml b/actions/organizations.upstream_subscriptions_update.yaml index bbbfd6f..22d994a 100644 --- a/actions/organizations.upstream_subscriptions_update.yaml +++ b/actions/organizations.upstream_subscriptions_update.yaml @@ -38,11 +38,11 @@ parameters: "description: Array of Pools to be updated. Only pools originating upstream are accepted. parameters: id: + description: orcharhino ID of local pool to update required: true type: string - description: Katello ID of local pool to update quantity: + description: Desired quantity of the pool required: true type: number - description: Desired quantity of the pool " \ No newline at end of file diff --git a/actions/organizations.users_index.yaml b/actions/organizations.users_index.yaml index 8af9cd2..934a856 100644 --- a/actions/organizations.users_index.yaml +++ b/actions/organizations.users_index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/ostree_branches.index.yaml b/actions/ostree_branches.index.yaml index 0b48cfa..c8206c1 100644 --- a/actions/ostree_branches.index.yaml +++ b/actions/ostree_branches.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/package_groups.index.yaml b/actions/package_groups.index.yaml index 15954c3..2f0c387 100644 --- a/actions/package_groups.index.yaml +++ b/actions/package_groups.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/permissions.index.yaml b/actions/permissions.index.yaml index 15977c4..9146507 100644 --- a/actions/permissions.index.yaml +++ b/actions/permissions.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,15 +42,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" resource_type: type: string required: false diff --git a/actions/permissions.resource_types.yaml b/actions/permissions.resource_types.yaml index e464fcf..199f018 100644 --- a/actions/permissions.resource_types.yaml +++ b/actions/permissions.resource_types.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/permissions.show.yaml b/actions/permissions.show.yaml index af48a5d..55411d4 100644 --- a/actions/permissions.show.yaml +++ b/actions/permissions.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/ping.index.yaml b/actions/ping.index.yaml index 8330d58..8b91e1e 100644 --- a/actions/ping.index.yaml +++ b/actions/ping.index.yaml @@ -1,5 +1,5 @@ --- -description: "Shows status of system and it's subcomponents (resource: GET /katello/api/ping)" +description: "Shows status of orcharhino system and it's subcomponents (resource: GET /katello/api/ping)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -26,4 +26,12 @@ parameters: type: string description: "Optional override of the password in . (required if is not specified)" required: false - secret: true \ No newline at end of file + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/ping.ping.yaml b/actions/ping.ping.yaml new file mode 100644 index 0000000..6655b92 --- /dev/null +++ b/actions/ping.ping.yaml @@ -0,0 +1,37 @@ +--- +description: "Shows status of orcharhino system and it's subcomponents (resource: GET /api/ping)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: ping.ping +pack: foreman +parameters: + operation: + type: string + default: ping.ping + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/products.products_bulk_actions_update_http_proxy.yaml b/actions/products.products_bulk_actions_update_http_proxy.yaml new file mode 100644 index 0000000..31fd113 --- /dev/null +++ b/actions/products.products_bulk_actions_update_http_proxy.yaml @@ -0,0 +1,41 @@ +--- +description: "Update the http proxy configuration on the repositories of one or more products. (resource: PUT /katello/api/products/bulk/http_proxy)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: products.products_bulk_actions_update_http_proxy +pack: foreman +parameters: + operation: + type: string + default: products.products_bulk_actions_update_http_proxy + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + ids: + type: array + required: true + description: "List of product ids" + http_proxy_policy: + type: string + required: false + description: "policy for http proxy for content sync" + http_proxy_id: + type: number + required: false + description: "Http Proxy identifier to associated" \ No newline at end of file diff --git a/actions/products.repositories_index.yaml b/actions/products.repositories_index.yaml index 446ddea..898242f 100644 --- a/actions/products.repositories_index.yaml +++ b/actions/products.repositories_index.yaml @@ -63,6 +63,10 @@ parameters: type: string required: false description: "Id of a file to find repositories that contain the file" + ansible_collection_id: + type: string + required: false + description: "Id of an ansible collection to find repositories that contain the ansiblecollection" ostree_branch_id: type: string required: false @@ -71,6 +75,10 @@ parameters: type: boolean required: false description: "show repositories in Library and the default content view" + archived: + type: boolean + required: false + description: "show archived repositories" content_type: type: string required: false @@ -91,6 +99,10 @@ parameters: type: string required: false description: "interpret specified object to return only Repositories that can beassociated with specified object. Only 'content_view' &'content_view_version' are supported." + with_content: + type: string + required: false + description: "only repositories having at least one of the specified content type ex: rpm, erratum" search: type: string required: false diff --git a/actions/products.repository_sets_index.yaml b/actions/products.repository_sets_index.yaml index 0493799..4043a43 100644 --- a/actions/products.repository_sets_index.yaml +++ b/actions/products.repository_sets_index.yaml @@ -47,6 +47,10 @@ parameters: type: number required: false description: "organization identifier" + with_custom: + type: boolean + required: false + description: "If true, return custom repository sets along with redhat repos" search: type: string required: false diff --git a/actions/provisioning_templates.build_pxe_default.yaml b/actions/provisioning_templates.build_pxe_default.yaml index f6f7dfe..0b09c4d 100644 --- a/actions/provisioning_templates.build_pxe_default.yaml +++ b/actions/provisioning_templates.build_pxe_default.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/provisioning_templates.clone.yaml b/actions/provisioning_templates.clone.yaml index 6403d96..77feddf 100644 --- a/actions/provisioning_templates.clone.yaml +++ b/actions/provisioning_templates.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: template name required: true type: string - description: template name " \ No newline at end of file diff --git a/actions/provisioning_templates.create.yaml b/actions/provisioning_templates.create.yaml index 3990dee..7618c6b 100644 --- a/actions/provisioning_templates.create.yaml +++ b/actions/provisioning_templates.create.yaml @@ -30,55 +30,59 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" provisioning_template: type: object required: true description: > "description: parameters: - operatingsystem_ids: - required: false - type: array - description: Array of operating system IDs to associate with the template - template_combinations_attributes: - required: false - type: array - description: Array of template combinations (hostgroup_id, environment_id) - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: template name required: true type: string - description: template name - snippet: - required: false - type: boolean + description: description: '' - template_kind_id: required: false - type: number - description: not relevant for snippet + type: string template: + description: '' required: true type: string + snippet: description: '' + required: false + type: boolean audit_comment: + description: '' required: false type: string - description: '' - location_ids: + template_kind_id: + description: not relevant for snippet + required: false + type: number + template_combinations_attributes: + description: Array of template combinations (hostgroup_id, environment_id) required: false type: array + operatingsystem_ids: + description: Array of operating system IDs to associate with the template + required: false + type: array + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean + location_ids: description: REPLACE locations with given ids - organization_ids: required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/provisioning_templates.destroy.yaml b/actions/provisioning_templates.destroy.yaml index b13ccf8..08761f7 100644 --- a/actions/provisioning_templates.destroy.yaml +++ b/actions/provisioning_templates.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/provisioning_templates.export.yaml b/actions/provisioning_templates.export.yaml index 15f6003..8dd97c2 100644 --- a/actions/provisioning_templates.export.yaml +++ b/actions/provisioning_templates.export.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/provisioning_templates.import_.yaml b/actions/provisioning_templates.import_.yaml index f9f082a..8d4635f 100644 --- a/actions/provisioning_templates.import_.yaml +++ b/actions/provisioning_templates.import_.yaml @@ -30,33 +30,33 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" provisioning_template: type: object required: true description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: template name required: false type: string - description: template name template: + description: template contents including metadata required: false type: string - description: template contents including metadata - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " options: type: object @@ -64,20 +64,20 @@ parameters: description: > "description: parameters: - default: + force: + description: use if you want update locked templates required: false type: boolean - description: makes the template default meaning it will be automatically associated withnewly created organizations and locations (false by default) - lock: + associate: + description: determines when the template should associate objects based on metadata,new means only when new template is being created, always means both fornew and existing template which is only being updated, never ignoresmetadata required: false - type: boolean + type: string + lock: description: lock imported templates (false by default) - force: required: false type: boolean - description: use if you want update locked templates - associate: + default: + description: makes the template default meaning it will be automatically associated withnewly created organizations and locations (false by default) required: false - type: string - description: determines when the template should associate objects based on metadata,new means only when new template is being created, always means both fornew and existing template which is only being updated, never ignoresmetadata + type: boolean " \ No newline at end of file diff --git a/actions/provisioning_templates.index.yaml b/actions/provisioning_templates.index.yaml index 21beee7..fd8349b 100644 --- a/actions/provisioning_templates.index.yaml +++ b/actions/provisioning_templates.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/provisioning_templates.operatingsystems_index.yaml b/actions/provisioning_templates.operatingsystems_index.yaml index 0ce79eb..2dde4a0 100644 --- a/actions/provisioning_templates.operatingsystems_index.yaml +++ b/actions/provisioning_templates.operatingsystems_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture_id: type: string required: false @@ -62,13 +62,13 @@ parameters: "description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value " search: type: string @@ -77,12 +77,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/provisioning_templates.os_default_templates_index.yaml b/actions/provisioning_templates.os_default_templates_index.yaml index 96fa0dc..e0489b6 100644 --- a/actions/provisioning_templates.os_default_templates_index.yaml +++ b/actions/provisioning_templates.os_default_templates_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" operatingsystem_id: type: string required: false @@ -48,10 +48,10 @@ parameters: required: true description: "ID of provisioning template" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/provisioning_templates.revision.yaml b/actions/provisioning_templates.revision.yaml index dd73a60..78b131d 100644 --- a/actions/provisioning_templates.revision.yaml +++ b/actions/provisioning_templates.revision.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" version: type: string required: false diff --git a/actions/provisioning_templates.show.yaml b/actions/provisioning_templates.show.yaml index 45abbf8..6fb6b8a 100644 --- a/actions/provisioning_templates.show.yaml +++ b/actions/provisioning_templates.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/provisioning_templates.template_combinations_create.yaml b/actions/provisioning_templates.template_combinations_create.yaml index a691f17..ace39db 100644 --- a/actions/provisioning_templates.template_combinations_create.yaml +++ b/actions/provisioning_templates.template_combinations_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false @@ -58,11 +58,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/provisioning_templates.template_combinations_index.yaml b/actions/provisioning_templates.template_combinations_index.yaml index e7eec48..fd4f602 100644 --- a/actions/provisioning_templates.template_combinations_index.yaml +++ b/actions/provisioning_templates.template_combinations_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/provisioning_templates.template_combinations_provisioning_template_id_template_showcombinations.yaml b/actions/provisioning_templates.template_combinations_provisioning_template_id_template_showcombinations.yaml index 719d606..d158d59 100644 --- a/actions/provisioning_templates.template_combinations_provisioning_template_id_template_showcombinations.yaml +++ b/actions/provisioning_templates.template_combinations_provisioning_template_id_template_showcombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/provisioning_templates.template_combinations_provisioning_template_id_template_updatecombinations.yaml b/actions/provisioning_templates.template_combinations_provisioning_template_id_template_updatecombinations.yaml index 532820f..91df814 100644 --- a/actions/provisioning_templates.template_combinations_provisioning_template_id_template_updatecombinations.yaml +++ b/actions/provisioning_templates.template_combinations_provisioning_template_id_template_updatecombinations.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -61,11 +61,11 @@ parameters: "description: parameters: environment_id: + description: environment id required: false type: number - description: environment id hostgroup_id: + description: host group id required: false type: number - description: host group id " \ No newline at end of file diff --git a/actions/provisioning_templates.update.yaml b/actions/provisioning_templates.update.yaml index e0385b8..93af0d4 100644 --- a/actions/provisioning_templates.update.yaml +++ b/actions/provisioning_templates.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,44 +44,48 @@ parameters: description: > "description: parameters: - operatingsystem_ids: - required: false - type: array - description: Array of operating system IDs to associate with the template - template_combinations_attributes: + name: + description: template name required: false - type: array - description: Array of template combinations (hostgroup_id, environment_id) - locked: + type: string + description: + description: '' required: false - type: boolean - description: Whether or not the template is locked for editing - name: + type: string + template: + description: '' required: false type: string - description: template name snippet: + description: '' required: false type: boolean + audit_comment: description: '' + required: false + type: string template_kind_id: + description: not relevant for snippet required: false type: number - description: not relevant for snippet - template: + template_combinations_attributes: + description: Array of template combinations (hostgroup_id, environment_id) required: false - type: string - description: '' - audit_comment: + type: array + operatingsystem_ids: + description: Array of operating system IDs to associate with the template required: false - type: string - description: '' + type: array + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/ptables.clone.yaml b/actions/ptables.clone.yaml index cc45607..892973a 100644 --- a/actions/ptables.clone.yaml +++ b/actions/ptables.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: template name required: true type: string - description: template name " \ No newline at end of file diff --git a/actions/ptables.create.yaml b/actions/ptables.create.yaml index 4f33560..620f8ca 100644 --- a/actions/ptables.create.yaml +++ b/actions/ptables.create.yaml @@ -30,59 +30,63 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" ptable: type: object required: true description: > "description: parameters: - host_ids: - required: false - type: array - description: Array of host IDs to associate with the partition table - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: '' required: true type: string + description: description: '' - location_ids: required: false - type: array - description: REPLACE locations with given ids + type: string + layout: + description: '' + required: true + type: string snippet: + description: '' required: false type: boolean + audit_comment: description: '' - os_family: required: false type: string + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean + os_family: description: '' + required: false + type: string operatingsystem_ids: + description: Array of operating system IDs to associate with the partition table required: false type: array - description: Array of operating system IDs to associate with the partition table - layout: - required: true - type: string - description: '' - audit_comment: + host_ids: + description: Array of host IDs to associate with the partition table required: false - type: string - description: '' + type: array hostgroup_ids: + description: Array of host group IDs to associate with the partition table required: false type: array - description: Array of host group IDs to associate with the partition table - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/ptables.destroy.yaml b/actions/ptables.destroy.yaml index 8492ccd..6293d60 100644 --- a/actions/ptables.destroy.yaml +++ b/actions/ptables.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/ptables.export.yaml b/actions/ptables.export.yaml index 35ff184..477999e 100644 --- a/actions/ptables.export.yaml +++ b/actions/ptables.export.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/ptables.import_.yaml b/actions/ptables.import_.yaml index 80a392b..340a1ba 100644 --- a/actions/ptables.import_.yaml +++ b/actions/ptables.import_.yaml @@ -30,33 +30,33 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" ptable: type: object required: true description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: template name required: false type: string - description: template name template: + description: template contents including metadata required: false type: string - description: template contents including metadata - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " options: type: object @@ -64,20 +64,20 @@ parameters: description: > "description: parameters: - default: + force: + description: use if you want update locked templates required: false type: boolean - description: makes the template default meaning it will be automatically associated withnewly created organizations and locations (false by default) - lock: + associate: + description: determines when the template should associate objects based on metadata,new means only when new template is being created, always means both fornew and existing template which is only being updated, never ignoresmetadata required: false - type: boolean + type: string + lock: description: lock imported templates (false by default) - force: required: false type: boolean - description: use if you want update locked templates - associate: + default: + description: makes the template default meaning it will be automatically associated withnewly created organizations and locations (false by default) required: false - type: string - description: determines when the template should associate objects based on metadata,new means only when new template is being created, always means both fornew and existing template which is only being updated, never ignoresmetadata + type: boolean " \ No newline at end of file diff --git a/actions/ptables.index.yaml b/actions/ptables.index.yaml index 0f3ac43..814fd26 100644 --- a/actions/ptables.index.yaml +++ b/actions/ptables.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/ptables.operatingsystems_index.yaml b/actions/ptables.operatingsystems_index.yaml index cbb1752..8d70c00 100644 --- a/actions/ptables.operatingsystems_index.yaml +++ b/actions/ptables.operatingsystems_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" architecture_id: type: string required: false @@ -62,13 +62,13 @@ parameters: "description: Array of parameters parameters: name: + description: Name of the parameter required: true type: string - description: Name of the parameter value: + description: Parameter value required: true type: string - description: Parameter value " search: type: string @@ -77,12 +77,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/ptables.revision.yaml b/actions/ptables.revision.yaml index df2d2cf..61523f9 100644 --- a/actions/ptables.revision.yaml +++ b/actions/ptables.revision.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" version: type: string required: false diff --git a/actions/ptables.show.yaml b/actions/ptables.show.yaml index d2d1384..a6e6acf 100644 --- a/actions/ptables.show.yaml +++ b/actions/ptables.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/ptables.update.yaml b/actions/ptables.update.yaml index 24a3ccd..ed78a54 100644 --- a/actions/ptables.update.yaml +++ b/actions/ptables.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,48 +44,52 @@ parameters: description: > "description: parameters: - host_ids: - required: false - type: array - description: Array of host IDs to associate with the partition table - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: '' required: false type: string + description: description: '' - location_ids: required: false - type: array - description: REPLACE locations with given ids + type: string + layout: + description: '' + required: false + type: string snippet: + description: '' required: false type: boolean + audit_comment: description: '' - os_family: required: false type: string + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean + os_family: description: '' - operatingsystem_ids: required: false - type: array + type: string + operatingsystem_ids: description: Array of operating system IDs to associate with the partition table - layout: required: false - type: string - description: '' - audit_comment: + type: array + host_ids: + description: Array of host IDs to associate with the partition table required: false - type: string - description: '' + type: array hostgroup_ids: + description: Array of host group IDs to associate with the partition table required: false type: array - description: Array of host group IDs to associate with the partition table - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/puppet_modules.index.yaml b/actions/puppet_modules.index.yaml index 5b044ab..5b6a2e3 100644 --- a/actions/puppet_modules.index.yaml +++ b/actions/puppet_modules.index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: false diff --git a/actions/puppetclasses.create.yaml b/actions/puppetclasses.create.yaml index 6a681f2..0367cb8 100644 --- a/actions/puppetclasses.create.yaml +++ b/actions/puppetclasses.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" puppetclass: type: object required: true @@ -42,7 +42,7 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/puppetclasses.destroy.yaml b/actions/puppetclasses.destroy.yaml index 088322c..cac9528 100644 --- a/actions/puppetclasses.destroy.yaml +++ b/actions/puppetclasses.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/puppetclasses.environments_index.yaml b/actions/puppetclasses.environments_index.yaml index d01338b..d40e250 100644 --- a/actions/puppetclasses.environments_index.yaml +++ b/actions/puppetclasses.environments_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/puppetclasses.hostgroups_index.yaml b/actions/puppetclasses.hostgroups_index.yaml index a344e9b..59aaabb 100644 --- a/actions/puppetclasses.hostgroups_index.yaml +++ b/actions/puppetclasses.hostgroups_index.yaml @@ -46,15 +46,15 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" + description: "Number of results per page to return" include: type: array required: false diff --git a/actions/puppetclasses.index.yaml b/actions/puppetclasses.index.yaml index 590f5de..03b60bc 100644 --- a/actions/puppetclasses.index.yaml +++ b/actions/puppetclasses.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/puppetclasses.show.yaml b/actions/puppetclasses.show.yaml index ea71d26..0475491 100644 --- a/actions/puppetclasses.show.yaml +++ b/actions/puppetclasses.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false diff --git a/actions/puppetclasses.smart_class_parameters_index.yaml b/actions/puppetclasses.smart_class_parameters_index.yaml index 91ee499..87895b4 100644 --- a/actions/puppetclasses.smart_class_parameters_index.yaml +++ b/actions/puppetclasses.smart_class_parameters_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/puppetclasses.smart_variables_index.yaml b/actions/puppetclasses.smart_variables_index.yaml index 546462f..d3d542b 100644 --- a/actions/puppetclasses.smart_variables_index.yaml +++ b/actions/puppetclasses.smart_variables_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -55,12 +55,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/puppetclasses.update.yaml b/actions/puppetclasses.update.yaml index 7165bdc..3cc9446 100644 --- a/actions/puppetclasses.update.yaml +++ b/actions/puppetclasses.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/realms.create.yaml b/actions/realms.create.yaml index 0951d89..f850d7c 100644 --- a/actions/realms.create.yaml +++ b/actions/realms.create.yaml @@ -30,35 +30,35 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" realm: type: object required: true description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids - realm_proxy_id: - required: true - type: number - description: Capsule ID to use within this realm name: + description: The realm name, e.g. EXAMPLE.COM required: true type: string - description: The realm name, e.g. EXAMPLE.COM + realm_proxy_id: + description: Proxy ID to use within this realm + required: true + type: number realm_type: + description: Realm type, e.g. FreeIPA or Active Directory required: true type: string - description: Realm type, e.g. Red Hat Identity Management or Active Directory - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/realms.destroy.yaml b/actions/realms.destroy.yaml index 4861ac5..8fa4fa5 100644 --- a/actions/realms.destroy.yaml +++ b/actions/realms.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/realms.index.yaml b/actions/realms.index.yaml index 4959cbf..c0fa12b 100644 --- a/actions/realms.index.yaml +++ b/actions/realms.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/realms.show.yaml b/actions/realms.show.yaml index 79376a4..7be1cde 100644 --- a/actions/realms.show.yaml +++ b/actions/realms.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/realms.update.yaml b/actions/realms.update.yaml index b9874cf..f59e052 100644 --- a/actions/realms.update.yaml +++ b/actions/realms.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,24 +44,24 @@ parameters: description: > "description: parameters: - location_ids: + name: + description: The realm name, e.g. EXAMPLE.COM required: false - type: array - description: REPLACE locations with given ids + type: string realm_proxy_id: + description: Proxy ID to use within this realm required: false type: number - description: Capsule ID to use within this realm - name: - required: false - type: string - description: The realm name, e.g. EXAMPLE.COM realm_type: + description: Realm type, e.g. FreeIPA or Active Directory required: false type: string - description: Realm type, e.g. Red Hat Identity Management or Active Directory - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/remote_execution_features.index.yaml b/actions/remote_execution_features.index.yaml index 47a13ea..1527959 100644 --- a/actions/remote_execution_features.index.yaml +++ b/actions/remote_execution_features.index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/remote_execution_features.show.yaml b/actions/remote_execution_features.show.yaml index 359af8c..4102d1b 100644 --- a/actions/remote_execution_features.show.yaml +++ b/actions/remote_execution_features.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/remote_execution_features.update.yaml b/actions/remote_execution_features.update.yaml index 72e4f0a..089dc01 100644 --- a/actions/remote_execution_features.update.yaml +++ b/actions/remote_execution_features.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: job_template_id: + description: Job template ID to be used for the feature required: false type: string - description: Job template ID to be used for the feature " \ No newline at end of file diff --git a/actions/report_templates.clone.yaml b/actions/report_templates.clone.yaml index 5da73de..85e985c 100644 --- a/actions/report_templates.clone.yaml +++ b/actions/report_templates.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: name: + description: template name required: true type: string - description: template name " \ No newline at end of file diff --git a/actions/report_templates.create.yaml b/actions/report_templates.create.yaml index a06568a..ffaaee5 100644 --- a/actions/report_templates.create.yaml +++ b/actions/report_templates.create.yaml @@ -30,47 +30,51 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" report_template: type: object required: true description: > "description: parameters: - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: '' required: true type: string + description: description: '' - default: - required: false - type: boolean - description: Whether or not the template is added automatically to new organizations andlocations - snippet: required: false - type: boolean - description: '' + type: string template: + description: '' required: true type: string + snippet: description: '' + required: false + type: boolean audit_comment: + description: '' required: false type: string - description: '' + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean + default: + description: Whether or not the template is added automatically to new organizations andlocations + required: false + type: boolean location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/report_templates.destroy.yaml b/actions/report_templates.destroy.yaml index 3eb70a5..2d37158 100644 --- a/actions/report_templates.destroy.yaml +++ b/actions/report_templates.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/report_templates.export.yaml b/actions/report_templates.export.yaml index 03b521d..05571ff 100644 --- a/actions/report_templates.export.yaml +++ b/actions/report_templates.export.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/report_templates.generate.yaml b/actions/report_templates.generate.yaml index a044b7d..ec56be7 100644 --- a/actions/report_templates.generate.yaml +++ b/actions/report_templates.generate.yaml @@ -1,5 +1,5 @@ --- -description: "Generate a report template (resource: POST /api/report_templates/:id/generate)" +description: "Generate report from a template (resource: POST /api/report_templates/:id/generate)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,15 +30,23 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true input_values: type: object required: false - description: "Hash of input values where key is the name of input, value is the value forthis input" \ No newline at end of file + description: "Hash of input values where key is the name of input, value is the value forthis input" + gzip: + type: boolean + required: false + description: "Compress the report uzing gzip" + report_format: + type: string + required: false + description: "Report format, defaults to 'csv'" \ No newline at end of file diff --git a/actions/report_templates.id_report_report_datadata.yaml b/actions/report_templates.id_report_report_datadata.yaml new file mode 100644 index 0000000..d1eec21 --- /dev/null +++ b/actions/report_templates.id_report_report_datadata.yaml @@ -0,0 +1,44 @@ +--- +description: "Downloads a generated report (resource: GET /api/report_templates/:id/report_data/:job_id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: report_templates.id_report_report_datadata +pack: foreman +parameters: + operation: + type: string + default: report_templates.id_report_report_datadata + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + job_id: + type: string + required: true + description: "ID assigned to generating job by the schedule command" \ No newline at end of file diff --git a/actions/report_templates.import_.yaml b/actions/report_templates.import_.yaml index 9060386..a8fe09f 100644 --- a/actions/report_templates.import_.yaml +++ b/actions/report_templates.import_.yaml @@ -30,33 +30,33 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" report_template: type: object required: true description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: template name required: false type: string - description: template name template: + description: template contents including metadata required: false type: string - description: template contents including metadata - organization_ids: + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " options: type: object @@ -64,20 +64,20 @@ parameters: description: > "description: parameters: - default: + force: + description: use if you want update locked templates required: false type: boolean - description: makes the template default meaning it will be automatically associated withnewly created organizations and locations (false by default) - lock: + associate: + description: determines when the template should associate objects based on metadata,new means only when new template is being created, always means both fornew and existing template which is only being updated, never ignoresmetadata required: false - type: boolean + type: string + lock: description: lock imported templates (false by default) - force: required: false type: boolean - description: use if you want update locked templates - associate: + default: + description: makes the template default meaning it will be automatically associated withnewly created organizations and locations (false by default) required: false - type: string - description: determines when the template should associate objects based on metadata,new means only when new template is being created, always means both fornew and existing template which is only being updated, never ignoresmetadata + type: boolean " \ No newline at end of file diff --git a/actions/report_templates.index.yaml b/actions/report_templates.index.yaml index 52d1355..c9c5ecc 100644 --- a/actions/report_templates.index.yaml +++ b/actions/report_templates.index.yaml @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/report_templates.revision.yaml b/actions/report_templates.revision.yaml index cf89fd3..dabde21 100644 --- a/actions/report_templates.revision.yaml +++ b/actions/report_templates.revision.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" version: type: string required: false diff --git a/actions/report_templates.schedule_report.yaml b/actions/report_templates.schedule_report.yaml new file mode 100644 index 0000000..3a1971d --- /dev/null +++ b/actions/report_templates.schedule_report.yaml @@ -0,0 +1,60 @@ +--- +description: "Schedule generating of a report (resource: POST /api/report_templates/:id/schedule_report)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: report_templates.schedule_report +pack: foreman +parameters: + operation: + type: string + default: report_templates.schedule_report + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + input_values: + type: object + required: false + description: "Hash of input values where key is the name of input, value is the value forthis input" + gzip: + type: boolean + required: false + description: "Compress the report using gzip" + mail_to: + type: string + required: false + description: "If set, scheduled report will be delivered via e-mail. Use ',' toseparate multiple email addresses." + generate_at: + type: string + required: false + description: "UTC time to generate report at" + report_format: + type: string + required: false + description: "Report format, defaults to 'csv'" \ No newline at end of file diff --git a/actions/report_templates.show.yaml b/actions/report_templates.show.yaml index ceef892..feb7360 100644 --- a/actions/report_templates.show.yaml +++ b/actions/report_templates.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/report_templates.update.yaml b/actions/report_templates.update.yaml index 904329c..40a5c71 100644 --- a/actions/report_templates.update.yaml +++ b/actions/report_templates.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,36 +44,40 @@ parameters: description: > "description: parameters: - locked: - required: false - type: boolean - description: Whether or not the template is locked for editing name: + description: '' required: false type: string + description: description: '' - default: - required: false - type: boolean - description: Whether or not the template is added automatically to new organizations andlocations - snippet: required: false - type: boolean - description: '' + type: string template: + description: '' required: false type: string + snippet: description: '' + required: false + type: boolean audit_comment: + description: '' required: false type: string - description: '' + locked: + description: Whether or not the template is locked for editing + required: false + type: boolean + default: + description: Whether or not the template is added automatically to new organizations andlocations + required: false + type: boolean location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/reports.create.yaml b/actions/reports.create.yaml index 6193d91..b5615a1 100644 --- a/actions/reports.create.yaml +++ b/actions/reports.create.yaml @@ -30,35 +30,35 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" report: type: object required: true description: > "description: parameters: - reported_at: + host: + description: Hostname or certname required: true type: string + reported_at: description: UTC time of report - status: required: true - type: object + type: string + status: description: Hash of status type totals - host: required: true - type: string - description: Hostname or certname + type: object metrics: + description: Hash of report metrics, can be just {} required: true type: object - description: Hash of report metrics, can be just {} logs: + description: Optional array of log hashes required: false type: array - description: Optional array of log hashes " \ No newline at end of file diff --git a/actions/reports.destroy.yaml b/actions/reports.destroy.yaml index 39772eb..cfcb687 100644 --- a/actions/reports.destroy.yaml +++ b/actions/reports.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/reports.index.yaml b/actions/reports.index.yaml index 823150f..3766c83 100644 --- a/actions/reports.index.yaml +++ b/actions/reports.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/reports.show.yaml b/actions/reports.show.yaml index 6ef6d33..67b3fad 100644 --- a/actions/reports.show.yaml +++ b/actions/reports.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/repositories.ansible_collections_epositories.yaml b/actions/repositories.ansible_collections_epositories.yaml new file mode 100644 index 0000000..55fdddf --- /dev/null +++ b/actions/repositories.ansible_collections_epositories.yaml @@ -0,0 +1,37 @@ +--- +description: "Show an ansible collection (resource: GET /katello/api/repositories/:repository_id/ansible_collections/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: repositories.ansible_collections_epositories +pack: foreman +parameters: + operation: + type: string + default: repositories.ansible_collections_epositories + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + repository_id: + type: number + required: true + description: "repository identifier" + id: + type: string + required: true + description: "an ansible collection identifier" \ No newline at end of file diff --git a/actions/repositories.ansible_collections_index.yaml b/actions/repositories.ansible_collections_index.yaml new file mode 100644 index 0000000..53fed4e --- /dev/null +++ b/actions/repositories.ansible_collections_index.yaml @@ -0,0 +1,85 @@ +--- +description: "List ansible_collections (resource: GET /katello/api/repositories/:repository_id/ansible_collections)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: repositories.ansible_collections_index +pack: foreman +parameters: + operation: + type: string + default: repositories.ansible_collections_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + organization_id: + type: number + required: false + description: "organization identifier" + content_view_version_id: + type: number + required: false + description: "content view version identifier" + content_view_filter_id: + type: number + required: false + description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" + repository_id: + type: number + required: true + description: "repository identifier" + environment_id: + type: number + required: false + description: "environment identifier" + ids: + type: array + required: false + description: "ids to filter content by" + search: + type: string + required: false + description: "Search string" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" + order: + type: string + required: false + description: "Sort field and order, eg. 'id DESC'" + full_result: + type: boolean + required: false + description: "Whether or not to show all results" + sort_by: + type: string + required: false + description: "Field to sort the results on" + sort_order: + type: string + required: false + description: "How to order the sorted results (e.g. ASC for ascending)" \ No newline at end of file diff --git a/actions/repositories.content_uploads_create.yaml b/actions/repositories.content_uploads_create.yaml index 98d9575..59932fa 100644 --- a/actions/repositories.content_uploads_create.yaml +++ b/actions/repositories.content_uploads_create.yaml @@ -30,4 +30,16 @@ parameters: repository_id: type: number required: true - description: "repository id" \ No newline at end of file + description: "repository id" + size: + type: number + required: true + description: "Size of file to upload" + checksum: + type: string + required: false + description: "Checksum of file to upload" + content_type: + type: string + required: false + description: "content type ('deb', 'docker_manifest', 'file','ostree', 'puppet_module', 'rpm', 'srpm')" \ No newline at end of file diff --git a/actions/repositories.content_uploads_epositories.yaml b/actions/repositories.content_uploads_epositories.yaml index 875c138..8f47832 100644 --- a/actions/repositories.content_uploads_epositories.yaml +++ b/actions/repositories.content_uploads_epositories.yaml @@ -32,9 +32,13 @@ parameters: required: true description: "Repository id" id: - type: number + type: string required: true description: "Upload request id" + size: + type: number + required: true + description: "Size of file to upload" offset: type: number required: true diff --git a/actions/repositories.create.yaml b/actions/repositories.create.yaml index 8fcfd59..f4b4b23 100644 --- a/actions/repositories.create.yaml +++ b/actions/repositories.create.yaml @@ -40,7 +40,7 @@ parameters: content_type: type: string required: true - description: "type of repo (either 'yum', 'deb', 'puppet','docker', or 'ostree')" + description: "type of repo" url: type: string required: false @@ -88,7 +88,7 @@ parameters: verify_ssl_on_sync: type: boolean required: false - description: "if true, Katello will verify the upstream url's SSL certifcates aresigned by a trusted CA" + description: "if true, orcharhino will verify the upstream url's SSL certifcates aresigned by a trusted CA" upstream_username: type: string required: false @@ -120,8 +120,24 @@ parameters: ignore_global_proxy: type: boolean required: false - description: "if true, will ignore the globally configured Capsule when syncing" + description: "if true, will ignore the globally configured proxy when syncing" + deb_errata_url: + type: string + required: false + description: "URL to a deb_errata service (use only on the security repositories)" ignorable_content: type: array required: false - description: "List of content units to ignore while syncing a yum repository. Must besubset of rpm,drpm,srpm,distribution,erratum" \ No newline at end of file + description: "List of content units to ignore while syncing a yum repository. Must besubset of rpm,drpm,srpm,distribution,erratum" + ansible_collection_requirements: + type: string + required: false + description: "Contents of requirement yaml file to sync from URL" + http_proxy_policy: + type: string + required: false + description: "policies for http proxy for content sync" + http_proxy_id: + type: number + required: false + description: "ID of a HTTP Proxy" \ No newline at end of file diff --git a/actions/repositories.debs_epositories.yaml b/actions/repositories.debs_epositories.yaml index 322c3f8..590b922 100644 --- a/actions/repositories.debs_epositories.yaml +++ b/actions/repositories.debs_epositories.yaml @@ -1,5 +1,5 @@ --- -description: "Show a deb (resource: GET /katello/api/repositories/:repository_id/debs/:id)" +description: "Show a deb package (resource: GET /katello/api/repositories/:repository_id/debs/:id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -34,4 +34,4 @@ parameters: id: type: string required: true - description: "a deb identifier" \ No newline at end of file + description: "a deb package identifier" \ No newline at end of file diff --git a/actions/repositories.debs_index.yaml b/actions/repositories.debs_index.yaml index 125d174..8862114 100644 --- a/actions/repositories.debs_index.yaml +++ b/actions/repositories.debs_index.yaml @@ -1,5 +1,5 @@ --- -description: "List debs (resource: GET /katello/api/repositories/:repository_id/debs)" +description: "List deb packages (resource: GET /katello/api/repositories/:repository_id/debs)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,27 +30,47 @@ parameters: organization_id: type: number required: false - description: "organization identifier" + description: "Organization identifier" content_view_version_id: type: number required: false - description: "content view version identifier" + description: "Content View Version identifier" content_view_filter_id: type: number required: false - description: "content view filter identifier" + description: "Content View Filter identifier" repository_id: type: number required: true - description: "repository identifier" + description: "Repository identifier" environment_id: type: number required: false - description: "environment identifier" + description: "Environment identifier" ids: type: array required: false - description: "ids to filter content by" + description: "Deb package identifiers to filter content by" + host_id: + type: number + required: false + description: "Host id to list applicable deb packages for" + packages_restrict_applicable: + type: boolean + required: false + description: "Return deb packages that are applicable to one or more hosts (defaults totrue if host_id is specified)" + packages_restrict_upgradable: + type: boolean + required: false + description: "Return deb packages that are upgradable on one or more hosts" + packages_restrict_latest: + type: boolean + required: false + description: "Return only the latest version of each package" + available_for: + type: string + required: false + description: "Return deb packages that can be added to the specified object. Only thevalue 'content_view_version' is supported." search: type: string required: false diff --git a/actions/repositories.docker_manifest_lists_index.yaml b/actions/repositories.docker_manifest_lists_index.yaml index 8c98695..404264a 100644 --- a/actions/repositories.docker_manifest_lists_index.yaml +++ b/actions/repositories.docker_manifest_lists_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.docker_manifests_index.yaml b/actions/repositories.docker_manifests_index.yaml index 92b64bb..d7e64ca 100644 --- a/actions/repositories.docker_manifests_index.yaml +++ b/actions/repositories.docker_manifests_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.docker_tags_index.yaml b/actions/repositories.docker_tags_index.yaml index 7eb4098..34898b7 100644 --- a/actions/repositories.docker_tags_index.yaml +++ b/actions/repositories.docker_tags_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.file_units_index.yaml b/actions/repositories.file_units_index.yaml index ea1be1c..97ec304 100644 --- a/actions/repositories.file_units_index.yaml +++ b/actions/repositories.file_units_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.import_uploads.yaml b/actions/repositories.import_uploads.yaml index 1abfe5a..856efda 100644 --- a/actions/repositories.import_uploads.yaml +++ b/actions/repositories.import_uploads.yaml @@ -47,30 +47,38 @@ parameters: type: boolean required: false description: "Whether or not to sync an external capsule after upload. Default: true" + content_type: + type: string + required: false + description: "content type ('deb', 'docker_manifest', 'file','ostree', 'puppet_module', 'rpm', 'srpm')" uploads: type: array required: false description: > "description: Array of uploads to import parameters: - checksum: - required: false + id: + description: '' + required: true type: string + content_unit_id: description: '' - digest: required: false type: string - description: Needs to only be set for docker tags - id: - required: true + size: + description: '' + required: false type: string + checksum: description: '' - name: required: false type: string + name: description: Needs to only be set for file repositories or docker tags - size: required: false type: string - description: '' + digest: + description: Needs to only be set for docker tags + required: false + type: string " \ No newline at end of file diff --git a/actions/repositories.index.yaml b/actions/repositories.index.yaml index ba35646..1f2f91e 100644 --- a/actions/repositories.index.yaml +++ b/actions/repositories.index.yaml @@ -63,6 +63,10 @@ parameters: type: string required: false description: "Id of a file to find repositories that contain the file" + ansible_collection_id: + type: string + required: false + description: "Id of an ansible collection to find repositories that contain the ansiblecollection" ostree_branch_id: type: string required: false @@ -71,6 +75,10 @@ parameters: type: boolean required: false description: "show repositories in Library and the default content view" + archived: + type: boolean + required: false + description: "show archived repositories" content_type: type: string required: false @@ -91,6 +99,10 @@ parameters: type: string required: false description: "interpret specified object to return only Repositories that can beassociated with specified object. Only 'content_view' &'content_view_version' are supported." + with_content: + type: string + required: false + description: "only repositories having at least one of the specified content type ex: rpm, erratum" search: type: string required: false diff --git a/actions/repositories.module_streams_index.yaml b/actions/repositories.module_streams_index.yaml index 2b3dd00..5266e34 100644 --- a/actions/repositories.module_streams_index.yaml +++ b/actions/repositories.module_streams_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.ostree_branches_index.yaml b/actions/repositories.ostree_branches_index.yaml index 5f44fb8..de0a46f 100644 --- a/actions/repositories.ostree_branches_index.yaml +++ b/actions/repositories.ostree_branches_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.package_groups_index.yaml b/actions/repositories.package_groups_index.yaml index 207d877..81f7787 100644 --- a/actions/repositories.package_groups_index.yaml +++ b/actions/repositories.package_groups_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.puppet_modules_index.yaml b/actions/repositories.puppet_modules_index.yaml index 8bf81b4..1cad7e4 100644 --- a/actions/repositories.puppet_modules_index.yaml +++ b/actions/repositories.puppet_modules_index.yaml @@ -39,6 +39,10 @@ parameters: type: number required: false description: "content view filter identifier" + content_view_filter_rule_id: + type: number + required: false + description: "content view filter rule identifier" repository_id: type: number required: true diff --git a/actions/repositories.remove_content.yaml b/actions/repositories.remove_content.yaml index d77fefb..7f86c2f 100644 --- a/actions/repositories.remove_content.yaml +++ b/actions/repositories.remove_content.yaml @@ -35,6 +35,10 @@ parameters: type: array required: true description: "Array of content ids to remove" + content_type: + type: string + required: false + description: "content type ('deb', 'docker_manifest', 'file','ostree', 'puppet_module', 'rpm', 'srpm')" sync_capsule: type: boolean required: false diff --git a/actions/repositories.srpms_epositories.yaml b/actions/repositories.srpms_epositories.yaml new file mode 100644 index 0000000..4849cbd --- /dev/null +++ b/actions/repositories.srpms_epositories.yaml @@ -0,0 +1,37 @@ +--- +description: "Show SRPM details (resource: GET /katello/api/repositories/:repository_id/srpms/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: repositories.srpms_epositories +pack: foreman +parameters: + operation: + type: string + default: repositories.srpms_epositories + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + repository_id: + type: number + required: true + description: "repository identifier" + id: + type: string + required: true + description: "SRPM details identifier" \ No newline at end of file diff --git a/actions/repositories.update.yaml b/actions/repositories.update.yaml index b0783dd..42137c8 100644 --- a/actions/repositories.update.yaml +++ b/actions/repositories.update.yaml @@ -81,7 +81,7 @@ parameters: verify_ssl_on_sync: type: boolean required: false - description: "if true, Katello will verify the upstream url's SSL certifcates aresigned by a trusted CA" + description: "if true, orcharhino will verify the upstream url's SSL certifcates aresigned by a trusted CA" upstream_username: type: string required: false @@ -113,8 +113,24 @@ parameters: ignore_global_proxy: type: boolean required: false - description: "if true, will ignore the globally configured Capsule when syncing" + description: "if true, will ignore the globally configured proxy when syncing" + deb_errata_url: + type: string + required: false + description: "URL to a deb_errata service (use only on the security repositories)" ignorable_content: type: array required: false - description: "List of content units to ignore while syncing a yum repository. Must besubset of rpm,drpm,srpm,distribution,erratum" \ No newline at end of file + description: "List of content units to ignore while syncing a yum repository. Must besubset of rpm,drpm,srpm,distribution,erratum" + ansible_collection_requirements: + type: string + required: false + description: "Contents of requirement yaml file to sync from URL" + http_proxy_policy: + type: string + required: false + description: "policies for http proxy for content sync" + http_proxy_id: + type: number + required: false + description: "ID of a HTTP Proxy" \ No newline at end of file diff --git a/actions/repositories.upload_content.yaml b/actions/repositories.upload_content.yaml index 87b924a..011ed64 100644 --- a/actions/repositories.upload_content.yaml +++ b/actions/repositories.upload_content.yaml @@ -34,4 +34,8 @@ parameters: content: type: string required: true - description: "Content files to upload. Can be a single file or array of files." \ No newline at end of file + description: "Content files to upload. Can be a single file or array of files." + content_type: + type: string + required: false + description: "content type ('deb', 'docker_manifest', 'file','ostree', 'puppet_module', 'rpm', 'srpm')" \ No newline at end of file diff --git a/actions/repository_sets.index.yaml b/actions/repository_sets.index.yaml index 79c197d..90af64f 100644 --- a/actions/repository_sets.index.yaml +++ b/actions/repository_sets.index.yaml @@ -47,6 +47,10 @@ parameters: type: number required: false description: "organization identifier" + with_custom: + type: boolean + required: false + description: "If true, return custom repository sets along with redhat repos" search: type: string required: false diff --git a/actions/roles.clone.yaml b/actions/roles.clone.yaml index 6f9ad78..c030f6c 100644 --- a/actions/roles.clone.yaml +++ b/actions/roles.clone.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,20 +44,20 @@ parameters: description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: '' required: false type: string - description: '' - organization_ids: + description: + description: Role description + required: false + type: string + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. - description: required: false - type: string - description: Role description + type: array " \ No newline at end of file diff --git a/actions/roles.create.yaml b/actions/roles.create.yaml index 11f5533..a871bf9 100644 --- a/actions/roles.create.yaml +++ b/actions/roles.create.yaml @@ -30,31 +30,31 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" role: type: object required: true description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: '' required: true type: string - description: '' - organization_ids: + description: + description: Role description + required: false + type: string + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. - description: required: false - type: string - description: Role description + type: array " \ No newline at end of file diff --git a/actions/roles.destroy.yaml b/actions/roles.destroy.yaml index be0aa65..0a345f1 100644 --- a/actions/roles.destroy.yaml +++ b/actions/roles.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/roles.index.yaml b/actions/roles.index.yaml index 39f916c..41a0874 100644 --- a/actions/roles.index.yaml +++ b/actions/roles.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/roles.show.yaml b/actions/roles.show.yaml index 0c4982d..e18d2e0 100644 --- a/actions/roles.show.yaml +++ b/actions/roles.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/roles.update.yaml b/actions/roles.update.yaml index 7f8c52e..33bff68 100644 --- a/actions/roles.update.yaml +++ b/actions/roles.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,20 +44,20 @@ parameters: description: > "description: parameters: - location_ids: - required: false - type: array - description: REPLACE locations with given ids name: + description: '' required: false type: string - description: '' - organization_ids: + description: + description: Role description + required: false + type: string + location_ids: + description: REPLACE locations with given ids required: false type: array + organization_ids: description: REPLACE organizations with given ids. - description: required: false - type: string - description: Role description + type: array " \ No newline at end of file diff --git a/actions/roles.users_index.yaml b/actions/roles.users_index.yaml index ce7445b..798b01f 100644 --- a/actions/roles.users_index.yaml +++ b/actions/roles.users_index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/scc_accounts.bulk_subscribe.yaml b/actions/scc_accounts.bulk_subscribe.yaml new file mode 100644 index 0000000..9652e3c --- /dev/null +++ b/actions/scc_accounts.bulk_subscribe.yaml @@ -0,0 +1,43 @@ +--- +description: "Bulk subscription of scc_products for scc_account (resource: PUT /api/v2/scc_accounts/:id/bulk_subscribe)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.bulk_subscribe +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.bulk_subscribe + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + scc_subscribe_product_ids: + type: array + required: false \ No newline at end of file diff --git a/actions/scc_accounts.create.yaml b/actions/scc_accounts.create.yaml new file mode 100644 index 0000000..af1eea1 --- /dev/null +++ b/actions/scc_accounts.create.yaml @@ -0,0 +1,72 @@ +--- +description: "Create an scc_account (resource: POST /api/v2/scc_accounts)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.create +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.create + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + scc_account: + type: object + required: true + description: > + "description: + parameters: + organization_id: + description: '' + required: true + type: string + name: + description: Name of the scc_account + required: true + type: string + login: + description: Login id of scc_account + required: true + type: string + password: + description: Password of scc_account + required: true + type: string + base_url: + description: URL of SUSE for scc_account + required: false + type: string + interval: + description: Interval for syncing scc_account + required: false + type: string + sync_date: + description: Last Sync time of scc_account + required: false + type: string + " \ No newline at end of file diff --git a/actions/scc_accounts.destroy.yaml b/actions/scc_accounts.destroy.yaml new file mode 100644 index 0000000..5c4cc68 --- /dev/null +++ b/actions/scc_accounts.destroy.yaml @@ -0,0 +1,40 @@ +--- +description: "Delete scc_account (resource: DELETE /api/v2/scc_accounts/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.destroy +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.destroy + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true \ No newline at end of file diff --git a/actions/scc_accounts.index.yaml b/actions/scc_accounts.index.yaml new file mode 100644 index 0000000..339691f --- /dev/null +++ b/actions/scc_accounts.index.yaml @@ -0,0 +1,52 @@ +--- +description: "List all scc_accounts (resource: GET /api/v2/scc_accounts)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.index +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: string + required: true + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/scc_accounts.scc_products_cc_showaccounts.yaml b/actions/scc_accounts.scc_products_cc_showaccounts.yaml new file mode 100644 index 0000000..e728c83 --- /dev/null +++ b/actions/scc_accounts.scc_products_cc_showaccounts.yaml @@ -0,0 +1,43 @@ +--- +description: "Show an scc_account product (resource: GET /api/v2/scc_accounts/:scc_account_id/scc_products/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.scc_products_cc_showaccounts +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.scc_products_cc_showaccounts + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + scc_account_id: + type: string + required: true \ No newline at end of file diff --git a/actions/scc_accounts.scc_products_cc_subscribeaccounts.yaml b/actions/scc_accounts.scc_products_cc_subscribeaccounts.yaml new file mode 100644 index 0000000..50a3607 --- /dev/null +++ b/actions/scc_accounts.scc_products_cc_subscribeaccounts.yaml @@ -0,0 +1,43 @@ +--- +description: "Subscribe product (resource: PUT /api/v2/scc_accounts/:scc_account_id/scc_products/:id/subscribe)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.scc_products_cc_subscribeaccounts +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.scc_products_cc_subscribeaccounts + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + scc_account_id: + type: string + required: true \ No newline at end of file diff --git a/actions/scc_accounts.scc_products_index.yaml b/actions/scc_accounts.scc_products_index.yaml new file mode 100644 index 0000000..73e56db --- /dev/null +++ b/actions/scc_accounts.scc_products_index.yaml @@ -0,0 +1,56 @@ +--- +description: "List all products for scc_account (resource: GET /api/v2/scc_accounts/:scc_account_id/scc_products)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.scc_products_index +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.scc_products_index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + scc_account_id: + type: string + required: true + search: + type: string + required: false + description: "filter results" + order: + type: string + required: false + description: "Sort field and order, eg. ‘id DESC’" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/scc_accounts.show.yaml b/actions/scc_accounts.show.yaml new file mode 100644 index 0000000..36183bf --- /dev/null +++ b/actions/scc_accounts.show.yaml @@ -0,0 +1,39 @@ +--- +description: "Show scc_account (resource: GET /api/v2/scc_accounts/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.show +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.show + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + id: + type: string + required: true + organization_id: + type: string + required: true \ No newline at end of file diff --git a/actions/scc_accounts.sync.yaml b/actions/scc_accounts.sync.yaml new file mode 100644 index 0000000..ce6b1ea --- /dev/null +++ b/actions/scc_accounts.sync.yaml @@ -0,0 +1,40 @@ +--- +description: "Sync scc_account (resource: PUT /api/v2/scc_accounts/:id/sync)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.sync +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.sync + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true \ No newline at end of file diff --git a/actions/scc_accounts.test_connection.yaml b/actions/scc_accounts.test_connection.yaml new file mode 100644 index 0000000..8b17766 --- /dev/null +++ b/actions/scc_accounts.test_connection.yaml @@ -0,0 +1,52 @@ +--- +description: "Test connection for scc_account (resource: POST /api/v2/scc_accounts/test_connection)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.test_connection +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.test_connection + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: false + login: + type: string + required: false + description: "Login id of scc_account" + scc_password: + type: string + required: false + description: "Password of scc_account" + base_url: + type: string + required: false + description: "URL of SUSE for scc_account" \ No newline at end of file diff --git a/actions/scc_accounts.update.yaml b/actions/scc_accounts.update.yaml new file mode 100644 index 0000000..4cb3bcd --- /dev/null +++ b/actions/scc_accounts.update.yaml @@ -0,0 +1,75 @@ +--- +description: "Update scc_account (resource: PUT /api/v2/scc_accounts/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: scc_accounts.update +pack: foreman +parameters: + operation: + type: string + default: scc_accounts.update + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" + id: + type: string + required: true + scc_account: + type: object + required: true + description: > + "description: + parameters: + organization_id: + description: '' + required: false + type: string + name: + description: Name of the scc_account + required: false + type: string + login: + description: Login id of scc_account + required: false + type: string + password: + description: Password of scc_account + required: false + type: string + base_url: + description: URL of SUSE for scc_account + required: false + type: string + interval: + description: Interval for syncing scc_account + required: false + type: string + sync_date: + description: Last Sync time of scc_account + required: false + type: string + " \ No newline at end of file diff --git a/actions/settings.index.yaml b/actions/settings.index.yaml index a5c130c..1197e53 100644 --- a/actions/settings.index.yaml +++ b/actions/settings.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/settings.show.yaml b/actions/settings.show.yaml index c8d7912..68af314 100644 --- a/actions/settings.show.yaml +++ b/actions/settings.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/settings.update.yaml b/actions/settings.update.yaml index 3218837..6c69f48 100644 --- a/actions/settings.update.yaml +++ b/actions/settings.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -45,7 +45,7 @@ parameters: "description: parameters: value: + description: '' required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/smart_class_parameters.index.yaml b/actions/smart_class_parameters.index.yaml index ee88585..843fd79 100644 --- a/actions/smart_class_parameters.index.yaml +++ b/actions/smart_class_parameters.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -58,12 +58,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/smart_class_parameters.override_values_create.yaml b/actions/smart_class_parameters.override_values_create.yaml index 9b20991..bb00f92 100644 --- a/actions/smart_class_parameters.override_values_create.yaml +++ b/actions/smart_class_parameters.override_values_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: false @@ -47,20 +47,20 @@ parameters: description: > "description: parameters: + match: + description: Override match + required: true + type: string + value: + description: Override value, required if omit is false + required: false + type: any_type use_puppet_default: + description: Deprecated, please use omit required: false type: boolean - description: Deprecated, please use omit omit: + description: orcharhino will not send this parameter in classification output, replacesuse_puppet_default required: false type: boolean - description: Satellite will not send this parameter in classification output, replacesuse_puppet_default - value: - required: false - type: any_type - description: Override value, required if omit is false - match: - required: true - type: string - description: Override match " \ No newline at end of file diff --git a/actions/smart_class_parameters.override_values_index.yaml b/actions/smart_class_parameters.override_values_index.yaml index e822c9a..f7a968e 100644 --- a/actions/smart_class_parameters.override_values_index.yaml +++ b/actions/smart_class_parameters.override_values_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: false @@ -46,10 +46,10 @@ parameters: required: false description: "Display hidden values" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_destroyvalues.yaml b/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_destroyvalues.yaml index 8af7065..719ce02 100644 --- a/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_destroyvalues.yaml +++ b/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_destroyvalues.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: false diff --git a/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_showvalues.yaml b/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_showvalues.yaml index a5ec9c1..958d757 100644 --- a/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_showvalues.yaml +++ b/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_showvalues.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: false diff --git a/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_updatevalues.yaml b/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_updatevalues.yaml index f3785a2..9e228f0 100644 --- a/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_updatevalues.yaml +++ b/actions/smart_class_parameters.override_values_smart_class_parameter_id_override_updatevalues.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: false @@ -47,20 +47,20 @@ parameters: description: > "description: parameters: + match: + description: Override match + required: false + type: string + value: + description: Override value, required if omit is false + required: false + type: any_type use_puppet_default: + description: Deprecated, please use omit required: false type: boolean - description: Deprecated, please use omit omit: + description: orcharhino will not send this parameter in classification output, replacesuse_puppet_default required: false type: boolean - description: Satellite will not send this parameter in classification output, replacesuse_puppet_default - value: - required: false - type: any_type - description: Override value, required if omit is false - match: - required: false - type: string - description: Override match " \ No newline at end of file diff --git a/actions/smart_class_parameters.show.yaml b/actions/smart_class_parameters.show.yaml index c4b5433..c7016cf 100644 --- a/actions/smart_class_parameters.show.yaml +++ b/actions/smart_class_parameters.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_class_parameters.update.yaml b/actions/smart_class_parameters.update.yaml index 9f1952d..2f30c74 100644 --- a/actions/smart_class_parameters.update.yaml +++ b/actions/smart_class_parameters.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,64 +44,64 @@ parameters: description: > "description: parameters: - default_value: + override: + description: Whether the smart class parameter value is managed by orcharhino required: false - type: any_type - description: Value to use when there is no match - validator_rule: + type: boolean + description: + description: Description of smart class required: false type: string - description: Used to enforce certain values for the parameter values - use_puppet_default: + default_value: + description: Value to use when there is no match + required: false + type: any_type + hidden_value: + description: When enabled the parameter is hidden in the UI required: false type: boolean + use_puppet_default: description: Deprecated, please use omit - required: required: false type: boolean - description: If true, will raise an error if there is no default value and no matcherprovide a value - avoid_duplicates: + omit: + description: orcharhino will not send this parameter in classification output. Puppetwill use the value defined in the Puppet manifest for this parameter required: false type: boolean - description: Remove duplicate values (only array type) - description: + path: + description: The order in which values are resolved required: false type: string - description: Description of smart class - override_value_order: + validator_type: + description: Types of validation values required: false type: string - description: The order in which values are resolved - omit: + validator_rule: + description: Used to enforce certain values for the parameter values required: false - type: boolean - description: Satellite will not send this parameter in classification output. Puppetwill use the value defined in the Puppet manifest for this parameter - parameter_type: + type: string + override_value_order: + description: The order in which values are resolved required: false type: string + parameter_type: description: Types of variable values - hidden_value: - required: false - type: boolean - description: When enabled the parameter is hidden in the UI - validator_type: required: false type: string - description: Types of validation values - override: + required: + description: If true, will raise an error if there is no default value and no matcherprovide a value required: false type: boolean - description: Whether the smart class parameter value is managed by Satellite - path: + merge_overrides: + description: Merge all matching values (only array/hash type) required: false - type: string - description: The order in which values are resolved + type: boolean merge_default: + description: Include default value when merging all matching values required: false type: boolean - description: Include default value when merging all matching values - merge_overrides: + avoid_duplicates: + description: Remove duplicate values (only array type) required: false type: boolean - description: Merge all matching values (only array/hash type) " \ No newline at end of file diff --git a/actions/smart_proxies.autosign_create.yaml b/actions/smart_proxies.autosign_create.yaml index 433b56e..8e3bfb0 100644 --- a/actions/smart_proxies.autosign_create.yaml +++ b/actions/smart_proxies.autosign_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_proxies.autosign_index.yaml b/actions/smart_proxies.autosign_index.yaml index 4efe768..5509936 100644 --- a/actions/smart_proxies.autosign_index.yaml +++ b/actions/smart_proxies.autosign_index.yaml @@ -1,5 +1,5 @@ --- -description: "List all autosign entries (resource: GET /api/smart_proxies/smart_proxy_id/autosign)" +description: "List all autosign entries (resource: GET /api/smart_proxies/:smart_proxy_id/autosign)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/smart_proxies.autosign_smart_proxy_id_destroyautosign.yaml b/actions/smart_proxies.autosign_smart_proxy_id_destroyautosign.yaml index a2c2b22..8583018 100644 --- a/actions/smart_proxies.autosign_smart_proxy_id_destroyautosign.yaml +++ b/actions/smart_proxies.autosign_smart_proxy_id_destroyautosign.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_proxies.create.yaml b/actions/smart_proxies.create.yaml index 6b9c5e2..f103926 100644 --- a/actions/smart_proxies.create.yaml +++ b/actions/smart_proxies.create.yaml @@ -1,5 +1,5 @@ --- -description: "Create a capsule (resource: POST /api/smart_proxies)" +description: "Create a smart proxy (resource: POST /api/smart_proxies)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,35 +30,35 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_proxy: type: object required: true description: > "description: parameters: - url: + name: + description: '' required: true type: string + url: description: '' + required: true + type: string location_ids: - required: false - type: array description: REPLACE locations with given ids - download_policy: required: false - type: string - description: Download Policy of the capsule, must be one of immediate, on_demand,background, inherit - name: - required: true - type: string - description: '' + type: array organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. + download_policy: + description: Download Policy of the capsule, must be one of immediate, on_demand,background, inherit + required: false + type: string " \ No newline at end of file diff --git a/actions/smart_proxies.destroy.yaml b/actions/smart_proxies.destroy.yaml index 44560d7..4b84f3e 100644 --- a/actions/smart_proxies.destroy.yaml +++ b/actions/smart_proxies.destroy.yaml @@ -1,5 +1,5 @@ --- -description: "Delete a capsule (resource: DELETE /api/smart_proxies/:id)" +description: "Delete a smart proxy (resource: DELETE /api/smart_proxies/:id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/smart_proxies.environments_import_puppetclasses.yaml b/actions/smart_proxies.environments_import_puppetclasses.yaml index 4602750..98c2c0b 100644 --- a/actions/smart_proxies.environments_import_puppetclasses.yaml +++ b/actions/smart_proxies.environments_import_puppetclasses.yaml @@ -1,5 +1,5 @@ --- -description: "Import puppet classes from puppet Capsule (resource: POST /api/smart_proxies/:id/import_puppetclasses)" +description: "Import puppet classes from puppet proxy (resource: POST /api/smart_proxies/:id/import_puppetclasses)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_proxies.environments_smart_proxy_id_import_puppetclassesenvironments.yaml b/actions/smart_proxies.environments_smart_proxy_id_import_puppetclassesenvironments.yaml index 7667303..686f474 100644 --- a/actions/smart_proxies.environments_smart_proxy_id_import_puppetclassesenvironments.yaml +++ b/actions/smart_proxies.environments_smart_proxy_id_import_puppetclassesenvironments.yaml @@ -1,5 +1,5 @@ --- -description: "Import puppet classes from puppet Capsule for an environment (resource: POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses)" +description: "Import puppet classes from puppet proxy for an environment (resource: POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_proxies.import_puppetclasses.yaml b/actions/smart_proxies.import_puppetclasses.yaml index 6577709..98ab110 100644 --- a/actions/smart_proxies.import_puppetclasses.yaml +++ b/actions/smart_proxies.import_puppetclasses.yaml @@ -1,5 +1,5 @@ --- -description: "Import puppet classes from puppet Capsule (resource: POST /api/smart_proxies/:id/import_puppetclasses)" +description: "Import puppet classes from puppet proxy (resource: POST /api/smart_proxies/:id/import_puppetclasses)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_proxies.index.yaml b/actions/smart_proxies.index.yaml index fc4f034..5bcf06b 100644 --- a/actions/smart_proxies.index.yaml +++ b/actions/smart_proxies.index.yaml @@ -1,5 +1,5 @@ --- -description: "List all capsules (resource: GET /api/smart_proxies)" +description: "List all smart proxies (resource: GET /api/smart_proxies)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/smart_proxies.refresh.yaml b/actions/smart_proxies.refresh.yaml index 9accb13..dc5514f 100644 --- a/actions/smart_proxies.refresh.yaml +++ b/actions/smart_proxies.refresh.yaml @@ -1,5 +1,5 @@ --- -description: "Refresh capsule features (resource: PUT /api/smart_proxies/:id/refresh)" +description: "Refresh smart proxy features (resource: PUT /api/smart_proxies/:id/refresh)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/smart_proxies.show.yaml b/actions/smart_proxies.show.yaml index cb4a7ec..6f43dd6 100644 --- a/actions/smart_proxies.show.yaml +++ b/actions/smart_proxies.show.yaml @@ -1,5 +1,5 @@ --- -description: "Show a capsule (resource: GET /api/smart_proxies/:id)" +description: "Show a smart proxy (resource: GET /api/smart_proxies/:id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/smart_proxies.smart_proxy_id_import_puppetclassesenvironments.yaml b/actions/smart_proxies.smart_proxy_id_import_puppetclassesenvironments.yaml index 1dd070a..e1c1eec 100644 --- a/actions/smart_proxies.smart_proxy_id_import_puppetclassesenvironments.yaml +++ b/actions/smart_proxies.smart_proxy_id_import_puppetclassesenvironments.yaml @@ -1,5 +1,5 @@ --- -description: "Import puppet classes from puppet Capsule for an environment (resource: POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses)" +description: "Import puppet classes from puppet proxy for an environment (resource: POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_proxies.update.yaml b/actions/smart_proxies.update.yaml index 899a3d0..8c8a634 100644 --- a/actions/smart_proxies.update.yaml +++ b/actions/smart_proxies.update.yaml @@ -1,5 +1,5 @@ --- -description: "Update a capsule (resource: PUT /api/smart_proxies/:id)" +description: "Update a smart proxy (resource: PUT /api/smart_proxies/:id)" enabled: true runner_type: "python-script" entry_point: lib/action.py @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,24 +44,24 @@ parameters: description: > "description: parameters: - url: + name: + description: '' required: false type: string + url: description: '' + required: false + type: string location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids - download_policy: + organization_ids: + description: REPLACE organizations with given ids. required: false - type: string + type: array + download_policy: description: Download Policy of the capsule, must be one of immediate, on_demand,background, inherit - name: required: false type: string - description: '' - organization_ids: - required: false - type: array - description: REPLACE organizations with given ids. " \ No newline at end of file diff --git a/actions/smart_variables.create.yaml b/actions/smart_variables.create.yaml index f503707..bf09b11 100644 --- a/actions/smart_variables.create.yaml +++ b/actions/smart_variables.create.yaml @@ -30,63 +30,63 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable: type: object required: true description: > "description: parameters: - default_value: + variable: + description: Name of variable + required: true + type: string + puppetclass_id: + description: Puppet class ID required: false - type: any_type + type: number + default_value: description: Default value of variable - validator_rule: required: false - type: string - description: Used to enforce certain values for the parameter values - avoid_duplicates: + type: any_type + hidden_value: + description: When enabled the parameter is hidden in the UI required: false type: boolean - description: Remove duplicate values (only array type) - description: + override_value_order: + description: The order in which values are resolved required: false type: string + description: description: Description of variable - override_value_order: required: false type: string - description: The order in which values are resolved - puppetclass_id: - required: false - type: number - description: Puppet class ID - merge_default: - required: false - type: boolean - description: Include default value when merging all matching values - hidden_value: - required: false - type: boolean - description: When enabled the parameter is hidden in the UI validator_type: + description: Types of validation values required: false type: string - description: Types of validation values - variable: - required: true + validator_rule: + description: Used to enforce certain values for the parameter values + required: false type: string - description: Name of variable variable_type: + description: Types of variable values required: false type: string - description: Types of variable values merge_overrides: + description: Merge all matching values (only array/hash type) + required: false + type: boolean + merge_default: + description: Include default value when merging all matching values + required: false + type: boolean + avoid_duplicates: + description: Remove duplicate values (only array type) required: false type: boolean - description: Merge all matching values (only array/hash type) " \ No newline at end of file diff --git a/actions/smart_variables.destroy.yaml b/actions/smart_variables.destroy.yaml index 85e6eba..61ee0e8 100644 --- a/actions/smart_variables.destroy.yaml +++ b/actions/smart_variables.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/smart_variables.index.yaml b/actions/smart_variables.index.yaml index d5de485..d2f83c3 100644 --- a/actions/smart_variables.index.yaml +++ b/actions/smart_variables.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: false @@ -55,12 +55,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/smart_variables.override_values_create.yaml b/actions/smart_variables.override_values_create.yaml index 0f386a0..8056522 100644 --- a/actions/smart_variables.override_values_create.yaml +++ b/actions/smart_variables.override_values_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: true @@ -47,20 +47,20 @@ parameters: description: > "description: parameters: + match: + description: Override match + required: true + type: string + value: + description: Override value, required if omit is false + required: false + type: any_type use_puppet_default: + description: Deprecated, please use omit required: false type: boolean - description: Deprecated, please use omit omit: + description: orcharhino will not send this parameter in classification output, replacesuse_puppet_default required: false type: boolean - description: Satellite will not send this parameter in classification output, replacesuse_puppet_default - value: - required: false - type: any_type - description: Override value, required if omit is false - match: - required: true - type: string - description: Override match " \ No newline at end of file diff --git a/actions/smart_variables.override_values_index.yaml b/actions/smart_variables.override_values_index.yaml index bbc6f3f..a7eddc8 100644 --- a/actions/smart_variables.override_values_index.yaml +++ b/actions/smart_variables.override_values_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: true @@ -46,10 +46,10 @@ parameters: required: false description: "Display hidden values" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/smart_variables.override_values_smart_variable_id_override_destroyvalues.yaml b/actions/smart_variables.override_values_smart_variable_id_override_destroyvalues.yaml index 1376ee1..401be19 100644 --- a/actions/smart_variables.override_values_smart_variable_id_override_destroyvalues.yaml +++ b/actions/smart_variables.override_values_smart_variable_id_override_destroyvalues.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: true diff --git a/actions/smart_variables.override_values_smart_variable_id_override_showvalues.yaml b/actions/smart_variables.override_values_smart_variable_id_override_showvalues.yaml index c10c3d0..b3ed1ed 100644 --- a/actions/smart_variables.override_values_smart_variable_id_override_showvalues.yaml +++ b/actions/smart_variables.override_values_smart_variable_id_override_showvalues.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: true diff --git a/actions/smart_variables.override_values_smart_variable_id_override_updatevalues.yaml b/actions/smart_variables.override_values_smart_variable_id_override_updatevalues.yaml index 38df748..fdbd511 100644 --- a/actions/smart_variables.override_values_smart_variable_id_override_updatevalues.yaml +++ b/actions/smart_variables.override_values_smart_variable_id_override_updatevalues.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" smart_variable_id: type: string required: true @@ -47,20 +47,20 @@ parameters: description: > "description: parameters: + match: + description: Override match + required: false + type: string + value: + description: Override value, required if omit is false + required: false + type: any_type use_puppet_default: + description: Deprecated, please use omit required: false type: boolean - description: Deprecated, please use omit omit: + description: orcharhino will not send this parameter in classification output, replacesuse_puppet_default required: false type: boolean - description: Satellite will not send this parameter in classification output, replacesuse_puppet_default - value: - required: false - type: any_type - description: Override value, required if omit is false - match: - required: false - type: string - description: Override match " \ No newline at end of file diff --git a/actions/smart_variables.show.yaml b/actions/smart_variables.show.yaml index 68c7edd..264463c 100644 --- a/actions/smart_variables.show.yaml +++ b/actions/smart_variables.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/smart_variables.update.yaml b/actions/smart_variables.update.yaml index a30defc..bf7bf9d 100644 --- a/actions/smart_variables.update.yaml +++ b/actions/smart_variables.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,52 +44,52 @@ parameters: description: > "description: parameters: - default_value: + variable: + description: Name of variable required: false - type: any_type + type: string + puppetclass_id: + description: Puppet class ID + required: false + type: number + default_value: description: Default value of variable - validator_rule: required: false - type: string - description: Used to enforce certain values for the parameter values - avoid_duplicates: + type: any_type + hidden_value: + description: When enabled the parameter is hidden in the UI required: false type: boolean - description: Remove duplicate values (only array type) - description: + override_value_order: + description: The order in which values are resolved required: false type: string + description: description: Description of variable - override_value_order: required: false type: string - description: The order in which values are resolved - puppetclass_id: - required: false - type: number - description: Puppet class ID - merge_default: - required: false - type: boolean - description: Include default value when merging all matching values - hidden_value: - required: false - type: boolean - description: When enabled the parameter is hidden in the UI validator_type: + description: Types of validation values required: false type: string - description: Types of validation values - variable: + validator_rule: + description: Used to enforce certain values for the parameter values required: false type: string - description: Name of variable variable_type: + description: Types of variable values required: false type: string - description: Types of variable values merge_overrides: + description: Merge all matching values (only array/hash type) + required: false + type: boolean + merge_default: + description: Include default value when merging all matching values + required: false + type: boolean + avoid_duplicates: + description: Remove duplicate values (only array type) required: false type: boolean - description: Merge all matching values (only array/hash type) " \ No newline at end of file diff --git a/actions/srpms.compare.yaml b/actions/srpms.compare.yaml new file mode 100644 index 0000000..c821b99 --- /dev/null +++ b/actions/srpms.compare.yaml @@ -0,0 +1,37 @@ +--- +description: "List srpms (resource: GET /katello/api/srpms/compare)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: srpms.compare +pack: foreman +parameters: + operation: + type: string + default: srpms.compare + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + content_view_version_ids: + type: array + required: false + description: "content view versions to compare" + repository_id: + type: number + required: false + description: "Library repository id to restrict comparisons to" \ No newline at end of file diff --git a/actions/srpms.index.yaml b/actions/srpms.index.yaml new file mode 100644 index 0000000..f71ac51 --- /dev/null +++ b/actions/srpms.index.yaml @@ -0,0 +1,73 @@ +--- +description: "List srpms (resource: GET /katello/api/srpms)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: srpms.index +pack: foreman +parameters: + operation: + type: string + default: srpms.index + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + organization_id: + type: number + required: false + description: "Organization identifier" + repository_id: + type: number + required: false + description: "Repository identifier" + environment_id: + type: number + required: false + description: "Environment identifier" + content_view_version_id: + type: number + required: false + description: "Content View Version identifier" + search: + type: string + required: false + description: "Search string" + page: + type: number + required: false + description: "Page number, starting at 1" + per_page: + type: number + required: false + description: "Number of results per page to return" + order: + type: string + required: false + description: "Sort field and order, eg. 'id DESC'" + full_result: + type: boolean + required: false + description: "Whether or not to show all results" + sort_by: + type: string + required: false + description: "Field to sort the results on" + sort_order: + type: string + required: false + description: "How to order the sorted results (e.g. ASC for ascending)" \ No newline at end of file diff --git a/actions/srpms.show.yaml b/actions/srpms.show.yaml new file mode 100644 index 0000000..c8342f2 --- /dev/null +++ b/actions/srpms.show.yaml @@ -0,0 +1,37 @@ +--- +description: "Show SRPM details (resource: GET /katello/api/srpms/:id)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: srpms.show +pack: foreman +parameters: + operation: + type: string + default: srpms.show + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + repository_id: + type: number + required: false + description: "repository identifier" + id: + type: string + required: true + description: "SRPM details identifier" \ No newline at end of file diff --git a/actions/statistics.index.yaml b/actions/statistics.index.yaml index 60bef9a..b23df7e 100644 --- a/actions/statistics.index.yaml +++ b/actions/statistics.index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/status.home_status.yaml b/actions/status.home_status.yaml index f14629a..27d09c5 100644 --- a/actions/status.home_status.yaml +++ b/actions/status.home_status.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/status.ping_server_status.yaml b/actions/status.ping_server_status.yaml index b137316..9cc1c1f 100644 --- a/actions/status.ping_server_status.yaml +++ b/actions/status.ping_server_status.yaml @@ -26,4 +26,12 @@ parameters: type: string description: "Optional override of the password in . (required if is not specified)" required: false - secret: true \ No newline at end of file + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/statuses.ping_statuses.yaml b/actions/statuses.ping_statuses.yaml new file mode 100644 index 0000000..81f5cfa --- /dev/null +++ b/actions/statuses.ping_statuses.yaml @@ -0,0 +1,37 @@ +--- +description: "Shows status and version information of orcharhino system and it's subcomponents (resource: GET /api/statuses)" +enabled: true +runner_type: "python-script" +entry_point: lib/action.py +name: statuses.ping_statuses +pack: foreman +parameters: + operation: + type: string + default: statuses.ping_statuses + immutable: true + connection: + type: string + description: "Name of from this pack's configuration that specifies how to connect to a server." + required: false + server: + type: string + description: "Optional override of the server in (required if is not specified)." + required: false + username: + type: string + description: "Optional override of the username in (example: username@domain.tld) (required if is not specified)." + required: false + password: + type: string + description: "Optional override of the password in . (required if is not specified)" + required: false + secret: true + location_id: + type: number + required: false + description: "Set the current location context for the request" + organization_id: + type: number + required: false + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/subnets.create.yaml b/actions/subnets.create.yaml index 9574676..34004ba 100644 --- a/actions/subnets.create.yaml +++ b/actions/subnets.create.yaml @@ -30,111 +30,111 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" subnet: type: object required: true description: > "description: parameters: - dns_primary: - required: false + name: + description: Subnet name + required: true type: string - description: Primary DNS for this subnet - template_id: - required: false - type: number - description: Template HTTP(S) Capsule ID to use within this subnet - dhcp_id: - required: false - type: number - description: DHCP Capsule ID to use within this subnet - dns_id: + description: + description: Subnet description required: false - type: number - description: DNS Capsule ID to use within this subnet - gateway: + type: string + network_type: + description: Type or protocol, IPv4 or IPv6, defaults to IPv4 required: false type: string + network: + description: Subnet network + required: true + type: string + mask: + description: Netmask for this subnet + required: true + type: string + gateway: description: Subnet gateway - boot_mode: required: false type: string - description: Default boot mode for interfaces assigned to this subnet, valid values are'Static', 'DHCP' - from: + dns_primary: + description: Primary DNS for this subnet required: false type: string - description: Starting IP Address for IP auto suggestion - network: - required: true + dns_secondary: + description: Secondary DNS for this subnet + required: false type: string - description: Subnet network - subnet_parameters_attributes: + ipam: + description: IP Address auto suggestion mode for this subnet. required: false - type: array - description: Array of parameters (name, value) - to: + type: string + from: + description: Starting IP Address for IP auto suggestion required: false type: string + to: description: Ending IP Address for IP auto suggestion - vlanid: required: false type: string + vlanid: description: VLAN ID for this subnet - tftp_id: required: false - type: number - description: TFTP Capsule ID to use within this subnet - httpboot_id: + type: string + mtu: + description: MTU for this subnet required: false type: number - description: HTTPBoot Capsule ID to use within this subnet - organization_ids: + domain_ids: + description: Domains in which this subnet is part required: false type: array - description: REPLACE organizations with given ids. - description: + dhcp_id: + description: DHCP Proxy ID to use within this subnet required: false - type: string - description: Subnet description - domain_ids: + type: number + tftp_id: + description: TFTP Proxy ID to use within this subnet required: false - type: array - description: Domains in which this subnet is part - dns_secondary: + type: number + httpboot_id: + description: HTTPBoot Proxy ID to use within this subnet required: false - type: string - description: Secondary DNS for this subnet - name: - required: true - type: string - description: Subnet name - ipam: + type: number + dns_id: + description: DNS Proxy ID to use within this subnet required: false - type: string - description: IP Address auto suggestion mode for this subnet, valid values are 'DHCP','Internal DB', 'None' - mask: - required: true - type: string - description: Netmask for this subnet - mtu: + type: number + template_id: + description: Template HTTP(S) Proxy ID to use within this subnet required: false type: number - description: MTU for this subnet discovery_id: + description: ID of Discovery Proxy to use within this subnet for managing connection todiscovered hosts required: false type: number - description: ID of Discovery Capsule to use within this subnet for managing connectionto discovered hosts - location_ids: + boot_mode: + description: Default boot mode for interfaces assigned to this subnet. + required: false + type: string + subnet_parameters_attributes: + description: Array of parameters (name, value) required: false type: array + location_ids: description: REPLACE locations with given ids - network_type: required: false - type: string - description: Type or protocol, IPv4 or IPv6, defaults to IPv4 + type: array + organization_ids: + description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/subnets.destroy.yaml b/actions/subnets.destroy.yaml index 71c4afb..27aa2f0 100644 --- a/actions/subnets.destroy.yaml +++ b/actions/subnets.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: number required: true diff --git a/actions/subnets.domains_index.yaml b/actions/subnets.domains_index.yaml index ab04bc3..863e059 100644 --- a/actions/subnets.domains_index.yaml +++ b/actions/subnets.domains_index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/subnets.freeip.yaml b/actions/subnets.freeip.yaml index 3d0dbe6..1976f80 100644 --- a/actions/subnets.freeip.yaml +++ b/actions/subnets.freeip.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/subnets.index.yaml b/actions/subnets.index.yaml index de177c2..0b2720b 100644 --- a/actions/subnets.index.yaml +++ b/actions/subnets.index.yaml @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/subnets.interfaces_index.yaml b/actions/subnets.interfaces_index.yaml index c6ea9b5..654b85a 100644 --- a/actions/subnets.interfaces_index.yaml +++ b/actions/subnets.interfaces_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" host_id: type: string required: true @@ -48,10 +48,10 @@ parameters: required: true description: "ID or name of subnet" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/subnets.parameters_create.yaml b/actions/subnets.parameters_create.yaml index 9c36937..b01aae8 100644 --- a/actions/subnets.parameters_create.yaml +++ b/actions/subnets.parameters_create.yaml @@ -62,11 +62,15 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' value: + description: '' + required: true + type: string + parameter_type: + description: Type of value required: true type: string - description: '' " \ No newline at end of file diff --git a/actions/subnets.parameters_index.yaml b/actions/subnets.parameters_index.yaml index 339343f..7d22181 100644 --- a/actions/subnets.parameters_index.yaml +++ b/actions/subnets.parameters_index.yaml @@ -66,12 +66,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/subnets.parameters_subnet_id_updateparameters.yaml b/actions/subnets.parameters_subnet_id_updateparameters.yaml index 4e3dcd5..6591629 100644 --- a/actions/subnets.parameters_subnet_id_updateparameters.yaml +++ b/actions/subnets.parameters_subnet_id_updateparameters.yaml @@ -66,11 +66,15 @@ parameters: "description: parameters: name: + description: '' required: false type: string - description: '' value: + description: '' + required: false + type: string + parameter_type: + description: Type of value required: false type: string - description: '' " \ No newline at end of file diff --git a/actions/subnets.show.yaml b/actions/subnets.show.yaml index 6d3c3ed..7fa15b9 100644 --- a/actions/subnets.show.yaml +++ b/actions/subnets.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/subnets.update.yaml b/actions/subnets.update.yaml index c094967..c3f552c 100644 --- a/actions/subnets.update.yaml +++ b/actions/subnets.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: number required: true @@ -45,100 +45,100 @@ parameters: description: > "description: parameters: - dns_primary: + name: + description: Subnet name required: false type: string - description: Primary DNS for this subnet - template_id: + description: + description: Subnet description required: false - type: number - description: Template HTTP(S) Capsule ID to use within this subnet - dhcp_id: + type: string + network_type: + description: Type or protocol, IPv4 or IPv6, defaults to IPv4 required: false - type: number - description: DHCP Capsule ID to use within this subnet - dns_id: + type: string + network: + description: Subnet network required: false - type: number - description: DNS Capsule ID to use within this subnet - gateway: + type: string + mask: + description: Netmask for this subnet required: false type: string + gateway: description: Subnet gateway - boot_mode: required: false type: string - description: Default boot mode for interfaces assigned to this subnet, valid values are'Static', 'DHCP' - from: + dns_primary: + description: Primary DNS for this subnet required: false type: string - description: Starting IP Address for IP auto suggestion - network: + dns_secondary: + description: Secondary DNS for this subnet required: false type: string - description: Subnet network - subnet_parameters_attributes: + ipam: + description: IP Address auto suggestion mode for this subnet. required: false - type: array - description: Array of parameters (name, value) - to: + type: string + from: + description: Starting IP Address for IP auto suggestion required: false type: string + to: description: Ending IP Address for IP auto suggestion - vlanid: required: false type: string + vlanid: description: VLAN ID for this subnet - tftp_id: required: false - type: number - description: TFTP Capsule ID to use within this subnet - httpboot_id: + type: string + mtu: + description: MTU for this subnet required: false type: number - description: HTTPBoot Capsule ID to use within this subnet - organization_ids: - required: false - type: array - description: REPLACE organizations with given ids. - description: - required: false - type: string - description: Subnet description domain_ids: + description: Domains in which this subnet is part required: false type: array - description: Domains in which this subnet is part - dns_secondary: + dhcp_id: + description: DHCP Proxy ID to use within this subnet required: false - type: string - description: Secondary DNS for this subnet - name: + type: number + tftp_id: + description: TFTP Proxy ID to use within this subnet required: false - type: string - description: Subnet name - ipam: + type: number + httpboot_id: + description: HTTPBoot Proxy ID to use within this subnet required: false - type: string - description: IP Address auto suggestion mode for this subnet, valid values are 'DHCP','Internal DB', 'None' - mask: + type: number + dns_id: + description: DNS Proxy ID to use within this subnet required: false - type: string - description: Netmask for this subnet - mtu: + type: number + template_id: + description: Template HTTP(S) Proxy ID to use within this subnet required: false type: number - description: MTU for this subnet discovery_id: + description: ID of Discovery Proxy to use within this subnet for managing connection todiscovered hosts required: false type: number - description: ID of Discovery Capsule to use within this subnet for managing connectionto discovered hosts - location_ids: + boot_mode: + description: Default boot mode for interfaces assigned to this subnet. + required: false + type: string + subnet_parameters_attributes: + description: Array of parameters (name, value) required: false type: array + location_ids: description: REPLACE locations with given ids - network_type: required: false - type: string - description: Type or protocol, IPv4 or IPv6, defaults to IPv4 + type: array + organization_ids: + description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/subscriptions.index.yaml b/actions/subscriptions.index.yaml index b1fb33f..7f65e55 100644 --- a/actions/subscriptions.index.yaml +++ b/actions/subscriptions.index.yaml @@ -57,7 +57,7 @@ parameters: description: "How to order the sorted results (e.g. ASC for ascending)" organization_id: type: number - required: true + required: false description: "Organization ID" host_id: type: string diff --git a/actions/sync_plans.destroy.yaml b/actions/sync_plans.destroy.yaml index e0521b1..e470c4f 100644 --- a/actions/sync_plans.destroy.yaml +++ b/actions/sync_plans.destroy.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: false - description: "Filter sync plans by organization name or label" + description: "Organization ID" id: type: number required: true diff --git a/actions/sync_plans.index.yaml b/actions/sync_plans.index.yaml index cc279dd..ca273ee 100644 --- a/actions/sync_plans.index.yaml +++ b/actions/sync_plans.index.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: true - description: "Filter sync plans by organization name or label" + description: "Organization ID" name: type: string required: false diff --git a/actions/sync_plans.show.yaml b/actions/sync_plans.show.yaml index 79a29f3..9a5fd53 100644 --- a/actions/sync_plans.show.yaml +++ b/actions/sync_plans.show.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: false - description: "Filter sync plans by organization name or label" + description: "Organization ID" id: type: number required: true diff --git a/actions/sync_plans.update.yaml b/actions/sync_plans.update.yaml index b4dc1a3..7843380 100644 --- a/actions/sync_plans.update.yaml +++ b/actions/sync_plans.update.yaml @@ -30,7 +30,7 @@ parameters: organization_id: type: number required: false - description: "Filter sync plans by organization name or label" + description: "Organization ID" id: type: number required: true diff --git a/actions/template_combinations.destroy.yaml b/actions/template_combinations.destroy.yaml index c8f4584..2922159 100644 --- a/actions/template_combinations.destroy.yaml +++ b/actions/template_combinations.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/template_combinations.show.yaml b/actions/template_combinations.show.yaml index a3156cf..63c8fde 100644 --- a/actions/template_combinations.show.yaml +++ b/actions/template_combinations.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" config_template_id: type: string required: false diff --git a/actions/template_kinds.index.yaml b/actions/template_kinds.index.yaml index d38b0e9..711b11a 100644 --- a/actions/template_kinds.index.yaml +++ b/actions/template_kinds.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/templates.foreign_input_sets_create.yaml b/actions/templates.foreign_input_sets_create.yaml index a246ea2..5540565 100644 --- a/actions/templates.foreign_input_sets_create.yaml +++ b/actions/templates.foreign_input_sets_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true @@ -44,24 +44,24 @@ parameters: description: > "description: parameters: - include: - required: false + target_template_id: + description: Target template ID + required: true type: string - description: A comma separated list of input names to be included from the foreigntemplate. include_all: + description: Include all inputs from the foreign template required: false type: boolean - description: Include all inputs from the foreign template - description: + include: + description: A comma separated list of input names to be included from the foreigntemplate. required: false type: string - description: Input set description - target_template_id: - required: true - type: string - description: Target template ID exclude: + description: A comma separated list of input names to be included from the foreigntemplate. + required: false + type: string + description: + description: Input set description required: false type: string - description: A comma separated list of input names to be included from the foreigntemplate. " \ No newline at end of file diff --git a/actions/templates.foreign_input_sets_index.yaml b/actions/templates.foreign_input_sets_index.yaml index dd31e1e..13075e7 100644 --- a/actions/templates.foreign_input_sets_index.yaml +++ b/actions/templates.foreign_input_sets_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true @@ -45,12 +45,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/templates.foreign_input_sets_template_id_foreign_input_destroysets.yaml b/actions/templates.foreign_input_sets_template_id_foreign_input_destroysets.yaml index 236aad8..c909245 100644 --- a/actions/templates.foreign_input_sets_template_id_foreign_input_destroysets.yaml +++ b/actions/templates.foreign_input_sets_template_id_foreign_input_destroysets.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true diff --git a/actions/templates.foreign_input_sets_template_id_foreign_input_showsets.yaml b/actions/templates.foreign_input_sets_template_id_foreign_input_showsets.yaml index f30a776..33c238f 100644 --- a/actions/templates.foreign_input_sets_template_id_foreign_input_showsets.yaml +++ b/actions/templates.foreign_input_sets_template_id_foreign_input_showsets.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true diff --git a/actions/templates.foreign_input_sets_template_id_foreign_input_updatesets.yaml b/actions/templates.foreign_input_sets_template_id_foreign_input_updatesets.yaml index 23ae782..5f88301 100644 --- a/actions/templates.foreign_input_sets_template_id_foreign_input_updatesets.yaml +++ b/actions/templates.foreign_input_sets_template_id_foreign_input_updatesets.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true @@ -47,24 +47,24 @@ parameters: description: > "description: parameters: - include: + target_template_id: + description: Target template ID required: false type: string - description: A comma separated list of input names to be included from the foreigntemplate. include_all: + description: Include all inputs from the foreign template required: false type: boolean - description: Include all inputs from the foreign template - description: + include: + description: A comma separated list of input names to be included from the foreigntemplate. required: false type: string - description: Input set description - target_template_id: + exclude: + description: A comma separated list of input names to be included from the foreigntemplate. required: false type: string - description: Target template ID - exclude: + description: + description: Input set description required: false type: string - description: A comma separated list of input names to be included from the foreigntemplate. " \ No newline at end of file diff --git a/actions/templates.template_export.yaml b/actions/templates.template_export.yaml index a03aff6..e49784e 100644 --- a/actions/templates.template_export.yaml +++ b/actions/templates.template_export.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" metadata_export_mode: type: string required: false diff --git a/actions/templates.template_import_.yaml b/actions/templates.template_import_.yaml index c897268..a9b2f7f 100644 --- a/actions/templates.template_import_.yaml +++ b/actions/templates.template_import_.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" prefix: type: string required: false diff --git a/actions/templates.template_inputs_create.yaml b/actions/templates.template_inputs_create.yaml index 3ee28f3..8de6cbf 100644 --- a/actions/templates.template_inputs_create.yaml +++ b/actions/templates.template_inputs_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true @@ -44,44 +44,56 @@ parameters: description: > "description: parameters: - fact_name: - required: false - type: string - description: Fact name, used when input type is fact name: - required: true - type: string description: Input name - input_type: required: true type: string - description: Input type + description: + description: Input description + required: false + type: string required: + description: Input is required required: false type: boolean - description: Input is required - puppet_parameter_name: + advanced: + description: Input is advanced required: false + type: boolean + input_type: + description: Input type + required: true type: string - description: Puppet parameter name, used when input type is puppet_parameter - puppet_class_name: + fact_name: + description: Fact name, used when input type is fact required: false type: string - description: Puppet class name, used when input type is puppet_parameter variable_name: + description: Variable name, used when input type is variable + required: false + type: string + puppet_class_name: + description: Puppet class name, used when input type is puppet_parameter + required: false + type: string + puppet_parameter_name: + description: Puppet parameter name, used when input type is puppet_parameter required: false type: string - description: Variable name, used when input type is variable options: + description: Selectable values for user inputs required: false type: array - description: Selectable values for user inputs - advanced: + default: + description: Default value for user input required: false - type: boolean - description: Input is advanced - description: + type: string + value_type: + description: Value type, defaults to plain + required: false + type: string + resource_type: + description: For values of type search, this is the resource the value searches in required: false type: string - description: Input description " \ No newline at end of file diff --git a/actions/templates.template_inputs_index.yaml b/actions/templates.template_inputs_index.yaml index 34c4afe..0cc9cd7 100644 --- a/actions/templates.template_inputs_index.yaml +++ b/actions/templates.template_inputs_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true @@ -45,12 +45,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/templates.template_inputs_template_id_template_destroyinputs.yaml b/actions/templates.template_inputs_template_id_template_destroyinputs.yaml index 7260993..3020fe6 100644 --- a/actions/templates.template_inputs_template_id_template_destroyinputs.yaml +++ b/actions/templates.template_inputs_template_id_template_destroyinputs.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true diff --git a/actions/templates.template_inputs_template_id_template_showinputs.yaml b/actions/templates.template_inputs_template_id_template_showinputs.yaml index a2796b5..4a00366 100644 --- a/actions/templates.template_inputs_template_id_template_showinputs.yaml +++ b/actions/templates.template_inputs_template_id_template_showinputs.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true diff --git a/actions/templates.template_inputs_template_id_template_updateinputs.yaml b/actions/templates.template_inputs_template_id_template_updateinputs.yaml index 1b36f23..65c050b 100644 --- a/actions/templates.template_inputs_template_id_template_updateinputs.yaml +++ b/actions/templates.template_inputs_template_id_template_updateinputs.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" template_id: type: string required: true @@ -47,44 +47,56 @@ parameters: description: > "description: parameters: - fact_name: - required: false - type: string - description: Fact name, used when input type is fact name: + description: Input name required: false type: string - description: Input name - input_type: + description: + description: Input description required: false type: string - description: Input type required: + description: Input is required required: false type: boolean - description: Input is required - puppet_parameter_name: + advanced: + description: Input is advanced + required: false + type: boolean + input_type: + description: Input type required: false type: string - description: Puppet parameter name, used when input type is puppet_parameter - puppet_class_name: + fact_name: + description: Fact name, used when input type is fact required: false type: string - description: Puppet class name, used when input type is puppet_parameter variable_name: + description: Variable name, used when input type is variable + required: false + type: string + puppet_class_name: + description: Puppet class name, used when input type is puppet_parameter + required: false + type: string + puppet_parameter_name: + description: Puppet parameter name, used when input type is puppet_parameter required: false type: string - description: Variable name, used when input type is variable options: + description: Selectable values for user inputs required: false type: array - description: Selectable values for user inputs - advanced: + default: + description: Default value for user input required: false - type: boolean - description: Input is advanced - description: + type: string + value_type: + description: Value type, defaults to plain + required: false + type: string + resource_type: + description: For values of type search, this is the resource the value searches in required: false type: string - description: Input description " \ No newline at end of file diff --git a/actions/trends.create.yaml b/actions/trends.create.yaml index b98ca7a..dad5ec5 100644 --- a/actions/trends.create.yaml +++ b/actions/trends.create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" trendable_type: type: string required: true diff --git a/actions/trends.destroy.yaml b/actions/trends.destroy.yaml index 98dfcc3..e851a37 100644 --- a/actions/trends.destroy.yaml +++ b/actions/trends.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/trends.index.yaml b/actions/trends.index.yaml index 49732cc..63a4edd 100644 --- a/actions/trends.index.yaml +++ b/actions/trends.index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/trends.show.yaml b/actions/trends.show.yaml index 12ca861..0498092 100644 --- a/actions/trends.show.yaml +++ b/actions/trends.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" trend_id: type: string required: true \ No newline at end of file diff --git a/actions/usergroups.create.yaml b/actions/usergroups.create.yaml index 734a5fe..287ad80 100644 --- a/actions/usergroups.create.yaml +++ b/actions/usergroups.create.yaml @@ -30,35 +30,35 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup: type: object required: true description: > "description: parameters: + name: + description: '' + required: true + type: string admin: + description: is an admin user group required: false type: boolean - description: is an admin user group user_ids: + description: '' required: false type: array + usergroup_ids: description: '' - role_ids: required: false type: array + role_ids: description: '' - usergroup_ids: required: false type: array - description: '' - name: - required: true - type: string - description: '' " \ No newline at end of file diff --git a/actions/usergroups.destroy.yaml b/actions/usergroups.destroy.yaml index 1308eac..639f410 100644 --- a/actions/usergroups.destroy.yaml +++ b/actions/usergroups.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/usergroups.external_usergroups_create.yaml b/actions/usergroups.external_usergroups_create.yaml index 1ac923d..e3e433a 100644 --- a/actions/usergroups.external_usergroups_create.yaml +++ b/actions/usergroups.external_usergroups_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true @@ -45,12 +45,12 @@ parameters: description: > "description: External user group information parameters: - auth_source_id: - required: true - type: number - description: ID of linked authentication source name: + description: External user group name required: true type: string - description: External user group name + auth_source_id: + description: ID of linked authentication source + required: true + type: number " \ No newline at end of file diff --git a/actions/usergroups.external_usergroups_index.yaml b/actions/usergroups.external_usergroups_index.yaml index 913cba0..c8b9c53 100644 --- a/actions/usergroups.external_usergroups_index.yaml +++ b/actions/usergroups.external_usergroups_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true diff --git a/actions/usergroups.external_usergroups_usergroup_id_external_destroyusergroups.yaml b/actions/usergroups.external_usergroups_usergroup_id_external_destroyusergroups.yaml index b546ea1..35e7275 100644 --- a/actions/usergroups.external_usergroups_usergroup_id_external_destroyusergroups.yaml +++ b/actions/usergroups.external_usergroups_usergroup_id_external_destroyusergroups.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true diff --git a/actions/usergroups.external_usergroups_usergroup_id_external_refreshusergroups.yaml b/actions/usergroups.external_usergroups_usergroup_id_external_refreshusergroups.yaml index 723b240..9ac5913 100644 --- a/actions/usergroups.external_usergroups_usergroup_id_external_refreshusergroups.yaml +++ b/actions/usergroups.external_usergroups_usergroup_id_external_refreshusergroups.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true diff --git a/actions/usergroups.external_usergroups_usergroup_id_external_showusergroups.yaml b/actions/usergroups.external_usergroups_usergroup_id_external_showusergroups.yaml index 4d214db..77963d0 100644 --- a/actions/usergroups.external_usergroups_usergroup_id_external_showusergroups.yaml +++ b/actions/usergroups.external_usergroups_usergroup_id_external_showusergroups.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true diff --git a/actions/usergroups.external_usergroups_usergroup_id_external_updateusergroups.yaml b/actions/usergroups.external_usergroups_usergroup_id_external_updateusergroups.yaml index 9f3a1bc..5155d9a 100644 --- a/actions/usergroups.external_usergroups_usergroup_id_external_updateusergroups.yaml +++ b/actions/usergroups.external_usergroups_usergroup_id_external_updateusergroups.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" usergroup_id: type: string required: true @@ -49,12 +49,12 @@ parameters: description: > "description: External user group information parameters: - auth_source_id: - required: false - type: number - description: ID of linked authentication source name: + description: External user group name required: false type: string - description: External user group name + auth_source_id: + description: ID of linked authentication source + required: false + type: number " \ No newline at end of file diff --git a/actions/usergroups.index.yaml b/actions/usergroups.index.yaml index 61f07c0..16fa39d 100644 --- a/actions/usergroups.index.yaml +++ b/actions/usergroups.index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" search: type: string required: false @@ -42,12 +42,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/usergroups.show.yaml b/actions/usergroups.show.yaml index b048390..d4e84b6 100644 --- a/actions/usergroups.show.yaml +++ b/actions/usergroups.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/usergroups.update.yaml b/actions/usergroups.update.yaml index 6e922ea..9df3b07 100644 --- a/actions/usergroups.update.yaml +++ b/actions/usergroups.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,24 +44,24 @@ parameters: description: > "description: parameters: + name: + description: '' + required: false + type: string admin: + description: is an admin user group required: false type: boolean - description: is an admin user group user_ids: - required: false - type: array description: '' - role_ids: required: false type: array - description: '' usergroup_ids: + description: '' required: false type: array + role_ids: description: '' - name: required: false - type: string - description: '' + type: array " \ No newline at end of file diff --git a/actions/usergroups.users_index.yaml b/actions/usergroups.users_index.yaml index 483ca5c..a688edc 100644 --- a/actions/usergroups.users_index.yaml +++ b/actions/usergroups.users_index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/users.create.yaml b/actions/users.create.yaml index eef379e..90fceb2 100644 --- a/actions/users.create.yaml +++ b/actions/users.create.yaml @@ -30,75 +30,75 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" user: type: object required: true description: > "description: parameters: - default_organization_id: - required: false - type: number + login: description: '' - role_ids: - required: false - type: array + required: true + type: string + firstname: description: '' - description: required: false type: string + lastname: description: '' - firstname: required: false type: string + mail: + description: '' + required: true + type: string + description: description: '' + required: false + type: string admin: + description: is an admin account required: false type: boolean - description: is an admin account - lastname: + password: + description: Required unless user is in an external authentication source required: false type: string - description: '' default_location_id: + description: '' required: false type: number + default_organization_id: description: '' - locale: - required: false - type: string - description: User's preferred locale - timezone: required: false - type: string - description: User's timezone - mail: - required: true - type: string + type: number + auth_source_id: description: '' - login: required: true + type: number + timezone: + description: User's timezone + required: false type: string - description: '' - password: + locale: + description: User's preferred locale required: false type: string - description: Required unless user is in an external authentication source - auth_source_id: - required: true - type: number + role_ids: description: '' - location_ids: required: false type: array + location_ids: description: REPLACE locations with given ids - organization_ids: required: false type: array + organization_ids: description: REPLACE organizations with given ids. + required: false + type: array " \ No newline at end of file diff --git a/actions/users.destroy.yaml b/actions/users.destroy.yaml index 4a44fa8..8db1ff4 100644 --- a/actions/users.destroy.yaml +++ b/actions/users.destroy.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/users.index.yaml b/actions/users.index.yaml index 3e60eb0..166e2df 100644 --- a/actions/users.index.yaml +++ b/actions/users.index.yaml @@ -54,12 +54,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/users.personal_access_tokens_create.yaml b/actions/users.personal_access_tokens_create.yaml index ea42b36..8bf59c5 100644 --- a/actions/users.personal_access_tokens_create.yaml +++ b/actions/users.personal_access_tokens_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" user_id: type: string required: true @@ -46,11 +46,11 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' expires_at: + description: Expiry Date required: false type: string - description: Expiry Date " \ No newline at end of file diff --git a/actions/users.personal_access_tokens_index.yaml b/actions/users.personal_access_tokens_index.yaml index 8a3638c..7b7766e 100644 --- a/actions/users.personal_access_tokens_index.yaml +++ b/actions/users.personal_access_tokens_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" user_id: type: string required: true @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/users.personal_access_tokens_user_id_personal_access_destroytokens.yaml b/actions/users.personal_access_tokens_user_id_personal_access_destroytokens.yaml index c2f14aa..931c02e 100644 --- a/actions/users.personal_access_tokens_user_id_personal_access_destroytokens.yaml +++ b/actions/users.personal_access_tokens_user_id_personal_access_destroytokens.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/users.personal_access_tokens_user_id_personal_access_showtokens.yaml b/actions/users.personal_access_tokens_user_id_personal_access_showtokens.yaml index 1c9be68..5aab9f4 100644 --- a/actions/users.personal_access_tokens_user_id_personal_access_showtokens.yaml +++ b/actions/users.personal_access_tokens_user_id_personal_access_showtokens.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/users.show.yaml b/actions/users.show.yaml index 4754478..08e6e37 100644 --- a/actions/users.show.yaml +++ b/actions/users.show.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true \ No newline at end of file diff --git a/actions/users.ssh_keys_create.yaml b/actions/users.ssh_keys_create.yaml index 2be2adb..4f971ad 100644 --- a/actions/users.ssh_keys_create.yaml +++ b/actions/users.ssh_keys_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" user_id: type: string required: true @@ -46,11 +46,11 @@ parameters: "description: parameters: name: + description: '' required: true type: string - description: '' key: + description: Public SSH key required: true type: string - description: Public SSH key " \ No newline at end of file diff --git a/actions/users.ssh_keys_index.yaml b/actions/users.ssh_keys_index.yaml index 0359199..0a150dd 100644 --- a/actions/users.ssh_keys_index.yaml +++ b/actions/users.ssh_keys_index.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" user_id: type: string required: true @@ -46,12 +46,12 @@ parameters: order: type: string required: false - description: "Sort field and order, eg. id DESC" + description: "Sort field and order, eg. ‘id DESC’" page: - type: string + type: number required: false - description: "paginate results" + description: "Page number, starting at 1" per_page: - type: string + type: number required: false - description: "number of entries per request" \ No newline at end of file + description: "Number of results per page to return" \ No newline at end of file diff --git a/actions/users.ssh_keys_user_id_ssh_destroykeys.yaml b/actions/users.ssh_keys_user_id_ssh_destroykeys.yaml index a46208c..29b0312 100644 --- a/actions/users.ssh_keys_user_id_ssh_destroykeys.yaml +++ b/actions/users.ssh_keys_user_id_ssh_destroykeys.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/users.ssh_keys_user_id_ssh_showkeys.yaml b/actions/users.ssh_keys_user_id_ssh_showkeys.yaml index 94b09d3..8a46960 100644 --- a/actions/users.ssh_keys_user_id_ssh_showkeys.yaml +++ b/actions/users.ssh_keys_user_id_ssh_showkeys.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true diff --git a/actions/users.table_preferences_create.yaml b/actions/users.table_preferences_create.yaml index 9db59e5..185aaa0 100644 --- a/actions/users.table_preferences_create.yaml +++ b/actions/users.table_preferences_create.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" table_preferences: type: object required: true @@ -42,11 +42,11 @@ parameters: "description: parameters: name: + description: Name of the table required: true type: string - description: Name of the table columns: + description: List of user selected columns required: false type: array - description: List of user selected columns " \ No newline at end of file diff --git a/actions/users.table_preferences_index.yaml b/actions/users.table_preferences_index.yaml index 90bf449..4ade7a4 100644 --- a/actions/users.table_preferences_index.yaml +++ b/actions/users.table_preferences_index.yaml @@ -30,8 +30,8 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" \ No newline at end of file + description: "Set the current organization context for the request" \ No newline at end of file diff --git a/actions/users.table_preferences_user_id_table_destroypreferences.yaml b/actions/users.table_preferences_user_id_table_destroypreferences.yaml index 6f730a8..3d3c919 100644 --- a/actions/users.table_preferences_user_id_table_destroypreferences.yaml +++ b/actions/users.table_preferences_user_id_table_destroypreferences.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" name: type: string required: true diff --git a/actions/users.table_preferences_user_id_table_showpreferences.yaml b/actions/users.table_preferences_user_id_table_showpreferences.yaml index 337e317..a7355c9 100644 --- a/actions/users.table_preferences_user_id_table_showpreferences.yaml +++ b/actions/users.table_preferences_user_id_table_showpreferences.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" name: type: string required: true \ No newline at end of file diff --git a/actions/users.table_preferences_user_id_table_updatepreferences.yaml b/actions/users.table_preferences_user_id_table_updatepreferences.yaml index 6a1be4d..26ecf21 100644 --- a/actions/users.table_preferences_user_id_table_updatepreferences.yaml +++ b/actions/users.table_preferences_user_id_table_updatepreferences.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" table_preferences: type: object required: true @@ -42,11 +42,11 @@ parameters: "description: parameters: name: + description: Name of the table required: true type: string - description: Name of the table columns: + description: List of user selected columns required: false type: array - description: List of user selected columns " \ No newline at end of file diff --git a/actions/users.update.yaml b/actions/users.update.yaml index c0bc3c4..8de2dc6 100644 --- a/actions/users.update.yaml +++ b/actions/users.update.yaml @@ -30,11 +30,11 @@ parameters: location_id: type: number required: false - description: "Scope by locations" + description: "Set the current location context for the request" organization_id: type: number required: false - description: "Scope by organizations" + description: "Set the current organization context for the request" id: type: string required: true @@ -44,68 +44,68 @@ parameters: description: > "description: parameters: - default_organization_id: + login: + description: '' required: false - type: number + type: string + firstname: description: '' - role_ids: required: false - type: array + type: string + lastname: description: '' - description: required: false type: string + mail: description: '' - firstname: required: false type: string + description: description: '' - current_password: required: false type: string - description: Required when user want to change own password admin: + description: is an admin account required: false type: boolean - description: is an admin account - lastname: + password: + description: Required unless user is in an external authentication source required: false type: string - description: '' default_location_id: + description: '' required: false type: number + default_organization_id: description: '' - locale: required: false - type: string - description: User's preferred locale - timezone: + type: number + auth_source_id: + description: '' required: false - type: string + type: number + timezone: description: User's timezone - mail: required: false type: string - description: '' - login: + locale: + description: User's preferred locale required: false type: string + role_ids: description: '' - password: - required: false - type: string - description: Required unless user is in an external authentication source - auth_source_id: required: false - type: number - description: '' + type: array location_ids: + description: REPLACE locations with given ids required: false type: array - description: REPLACE locations with given ids organization_ids: + description: REPLACE organizations with given ids. required: false type: array - description: REPLACE organizations with given ids. + current_password: + description: Required when user want to change own password + required: false + type: string " \ No newline at end of file diff --git a/etc/action_table.md b/etc/action_table.md index bdec50c..6c59658 100644 --- a/etc/action_table.md +++ b/etc/action_table.md @@ -18,6 +18,11 @@ | activation_keys.subscriptions_create | [POST /katello/api/activation_keys/:activation_key_id/subscriptions](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/subscriptions/create.html) | Add a subscription to an activation key | | activation_keys.subscriptions_index | [GET /katello/api/activation_keys/:activation_key_id/subscriptions](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/subscriptions/index.html) | List an activation key's subscriptions | | activation_keys.update | [PUT /katello/api/activation_keys/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/activation_keys/update.html) | Update an activation key | +| ansible_collections.compare | [GET /katello/api/ansible_collections/compare](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/compare.html) | List :resource | +| ansible_collections.index | [GET /katello/api/ansible_collections](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/index.html) | List ansible_collections | +| ansible_collections.show | [GET /katello/api/ansible_collections/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/show.html) | Show an ansible collection | +| ansible_inventories.hosts | [POST /api/ansible_inventories/hosts](https://theforeman.org/api/1.16/apidoc/v2/ansible_inventories/hosts.html) | Show Ansible inventory for hosts | +| ansible_inventories.schedule | [POST /api/ansible_inventories/schedule](https://theforeman.org/api/1.16/apidoc/v2/ansible_inventories/schedule.html) | Schedule generating of Ansible Inventory report | | api.home_index | [GET /api](https://theforeman.org/api/1.16/apidoc/v2/home/index.html) | Show available API links | | architectures.create | [POST /api/architectures](https://theforeman.org/api/1.16/apidoc/v2/architectures/create.html) | Create an architecture | | architectures.destroy | [DELETE /api/architectures/:id](https://theforeman.org/api/1.16/apidoc/v2/architectures/destroy.html) | Delete an architecture | @@ -50,51 +55,32 @@ | bookmarks.index | [GET /api/bookmarks](https://theforeman.org/api/1.16/apidoc/v2/bookmarks/index.html) | List all bookmarks | | bookmarks.show | [GET /api/bookmarks/:id](https://theforeman.org/api/1.16/apidoc/v2/bookmarks/show.html) | Show a bookmark | | bookmarks.update | [PUT /api/bookmarks/:id](https://theforeman.org/api/1.16/apidoc/v2/bookmarks/update.html) | Update a bookmark | -| capsules.capsule_content_add_lifecycle_environment | [POST /katello/api/capsules/:id/content/lifecycle_environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/add_lifecycle_environment.html) | Add lifecycle environments to the capsule | -| capsules.capsule_content_apsules | [DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/remove_lifecycle_environment.html) | Remove lifecycle environments from the capsule | -| capsules.capsule_content_available_lifecycle_environments | [GET /katello/api/capsules/:id/content/available_lifecycle_environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/available_lifecycle_environments.html) | List the lifecycle environments not attached to the capsule | -| capsules.capsule_content_cancel_sync | [DELETE /katello/api/capsules/:id/content/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/cancel_sync.html) | Cancel running capsule synchronization | -| capsules.capsule_content_lifecycle_environments | [GET /katello/api/capsules/:id/content/lifecycle_environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/lifecycle_environments.html) | List the lifecycle environments attached to the capsule | -| capsules.capsule_content_sync | [POST /katello/api/capsules/:id/content/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/sync.html) | Synchronize the content to the capsule | -| capsules.capsule_content_sync_status | [GET /katello/api/capsules/:id/content/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/sync_status.html) | Get current capsule synchronization status | -| capsules.index | [GET /katello/api/capsules](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsules/index.html) | List all capsules that have content | -| capsules.show | [GET /katello/api/capsules/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsules/show.html) | Show the capsule details | +| capsules.capsule_content_add_lifecycle_environment | [POST /katello/api/capsules/:id/content/lifecycle_environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/add_lifecycle_environment.html) | Add lifecycle environments to the smart proxy | +| capsules.capsule_content_apsules | [DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/remove_lifecycle_environment.html) | Remove lifecycle environments from the smart proxy | +| capsules.capsule_content_available_lifecycle_environments | [GET /katello/api/capsules/:id/content/available_lifecycle_environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/available_lifecycle_environments.html) | List the lifecycle environments not attached to the smart proxy | +| capsules.capsule_content_cancel_sync | [DELETE /katello/api/capsules/:id/content/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/cancel_sync.html) | Cancel running smart proxy synchronization | +| capsules.capsule_content_lifecycle_environments | [GET /katello/api/capsules/:id/content/lifecycle_environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/lifecycle_environments.html) | List the lifecycle environments attached to the smart proxy | +| capsules.capsule_content_sync | [POST /katello/api/capsules/:id/content/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/sync.html) | Synchronize the content to the smart proxy | +| capsules.capsule_content_sync_status | [GET /katello/api/capsules/:id/content/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsule_content/sync_status.html) | Get current smart proxy synchronization status | +| capsules.index | [GET /katello/api/capsules](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsules/index.html) | List all smart proxies that have content | +| capsules.show | [GET /katello/api/capsules/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/capsules/show.html) | Show the smart proxy details | | common_parameters.create | [POST /api/common_parameters](https://theforeman.org/api/1.16/apidoc/v2/common_parameters/create.html) | Create a global parameter | | common_parameters.destroy | [DELETE /api/common_parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/common_parameters/destroy.html) | Delete a global parameter | | common_parameters.index | [GET /api/common_parameters](https://theforeman.org/api/1.16/apidoc/v2/common_parameters/index.html) | List all global parameters | | common_parameters.show | [GET /api/common_parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/common_parameters/show.html) | Show a global parameter | | common_parameters.update | [PUT /api/common_parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/common_parameters/update.html) | Update a global parameter | -| compliance.arf_reports_destroy | [DELETE /api/compliance/arf_reports/:id](https://theforeman.org/api/1.16/apidoc/v2/arf_reports/destroy.html) | Delete an ARF Report | -| compliance.arf_reports_download | [GET /api/compliance/arf_reports/:id/download](https://theforeman.org/api/1.16/apidoc/v2/arf_reports/download.html) | Download bzipped ARF report | -| compliance.arf_reports_download_html | [GET /api/compliance/arf_reports/:id/download_html](https://theforeman.org/api/1.16/apidoc/v2/arf_reports/download_html.html) | Download ARF report in HTML | -| compliance.arf_reports_index | [GET /api/compliance/arf_reports](https://theforeman.org/api/1.16/apidoc/v2/arf_reports/index.html) | List ARF reports | -| compliance.arf_reports_rf | [POST /api/compliance/arf/:cname/:policy_id/:date](https://theforeman.org/api/1.16/apidoc/v2/arf_reports/create.html) | Upload an ARF report | -| compliance.arf_reports_show | [GET /api/compliance/arf_reports/:id](https://theforeman.org/api/1.16/apidoc/v2/arf_reports/show.html) | Show an ARF report | -| compliance.policies_content | [GET /api/compliance/policies/:id/content](https://theforeman.org/api/1.16/apidoc/v2/policies/content.html) | Show a policy's SCAP content | -| compliance.policies_create | [POST /api/compliance/policies](https://theforeman.org/api/1.16/apidoc/v2/policies/create.html) | Create a Policy | -| compliance.policies_destroy | [DELETE /api/compliance/policies/:id](https://theforeman.org/api/1.16/apidoc/v2/policies/destroy.html) | Delete a Policy | -| compliance.policies_index | [GET /api/compliance/policies](https://theforeman.org/api/1.16/apidoc/v2/policies/index.html) | List Policies | -| compliance.policies_show | [GET /api/compliance/policies/:id](https://theforeman.org/api/1.16/apidoc/v2/policies/show.html) | Show a Policy | -| compliance.policies_tailoring | [GET /api/compliance/policies/:id/tailoring](https://theforeman.org/api/1.16/apidoc/v2/policies/tailoring.html) | Show a policy's Tailoring file | -| compliance.policies_update | [PUT /api/compliance/policies/:id](https://theforeman.org/api/1.16/apidoc/v2/policies/update.html) | Update a Policy | -| compliance.scap_contents_create | [POST /api/compliance/scap_contents](https://theforeman.org/api/1.16/apidoc/v2/scap_contents/create.html) | Create SCAP content | -| compliance.scap_contents_destroy | [DELETE /api/compliance/scap_contents/:id](https://theforeman.org/api/1.16/apidoc/v2/scap_contents/destroy.html) | Deletes an SCAP content | -| compliance.scap_contents_index | [GET /api/compliance/scap_contents](https://theforeman.org/api/1.16/apidoc/v2/scap_contents/index.html) | List SCAP contents | -| compliance.scap_contents_show | [GET /api/compliance/scap_contents/:id](https://theforeman.org/api/1.16/apidoc/v2/scap_contents/show.html) | Show an SCAP content | -| compliance.scap_contents_update | [PUT /api/compliance/scap_contents/:id](https://theforeman.org/api/1.16/apidoc/v2/scap_contents/update.html) | Update an SCAP content | -| compliance.scap_contents_xml | [GET /api/compliance/scap_contents/:id/xml](https://theforeman.org/api/1.16/apidoc/v2/scap_contents/xml.html) | Download an SCAP content as XML | -| compliance.tailoring_files_create | [POST /api/compliance/tailoring_files](https://theforeman.org/api/1.16/apidoc/v2/tailoring_files/create.html) | Create a Tailoring file | -| compliance.tailoring_files_destroy | [DELETE /api/compliance/tailoring_files/:id](https://theforeman.org/api/1.16/apidoc/v2/tailoring_files/destroy.html) | Deletes a Tailoring file | -| compliance.tailoring_files_index | [GET /api/compliance/tailoring_files](https://theforeman.org/api/1.16/apidoc/v2/tailoring_files/index.html) | List Tailoring files | -| compliance.tailoring_files_show | [GET /api/compliance/tailoring_files/:id](https://theforeman.org/api/1.16/apidoc/v2/tailoring_files/show.html) | Show a Tailoring file | -| compliance.tailoring_files_update | [PUT /api/compliance/tailoring_files/:id](https://theforeman.org/api/1.16/apidoc/v2/tailoring_files/update.html) | Update a Tailoring file | -| compliance.tailoring_files_xml | [GET /api/compliance/tailoring_files/:id/xml](https://theforeman.org/api/1.16/apidoc/v2/tailoring_files/xml.html) | Download a Tailoring file as XML | | compute_attributes.create | [POST /api/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/create.html) | Create a compute attributes set | +| compute_attributes.index | [GET /api/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/index.html) | List of compute attributes | +| compute_attributes.show | [GET /api/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/show.html) | Show a compute attributes set | | compute_attributes.update | [PUT /api/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/update.html) | Update a compute attributes set | | compute_profiles.compute_attributes_compute_profile_id_compute_createresources | [POST /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/create.html) | Create a compute attributes set | +| compute_profiles.compute_attributes_compute_profile_id_compute_indexresources | [GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/index.html) | List of compute attributes for provided compute profile and compute resource | +| compute_profiles.compute_attributes_compute_profile_id_compute_showattributes | [GET /api/compute_profiles/:compute_profile_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/show.html) | Show a compute attributes set | +| compute_profiles.compute_attributes_compute_profile_id_compute_showresources | [GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/show.html) | Show a compute attributes set | | compute_profiles.compute_attributes_compute_profile_id_compute_updateattributes | [PUT /api/compute_profiles/:compute_profile_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/update.html) | Update a compute attributes set | | compute_profiles.compute_attributes_compute_profile_id_compute_updateresources | [PUT /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/update.html) | Update a compute attributes set | | compute_profiles.compute_attributes_create | [POST /api/compute_profiles/:compute_profile_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/create.html) | Create a compute attributes set | +| compute_profiles.compute_attributes_index | [GET /api/compute_profiles/:compute_profile_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/index.html) | List of compute attributes for compute profile | | compute_profiles.create | [POST /api/compute_profiles](https://theforeman.org/api/1.16/apidoc/v2/compute_profiles/create.html) | Create a compute profile | | compute_profiles.destroy | [DELETE /api/compute_profiles/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_profiles/destroy.html) | Delete a compute profile | | compute_profiles.index | [GET /api/compute_profiles](https://theforeman.org/api/1.16/apidoc/v2/compute_profiles/index.html) | List of compute profiles | @@ -111,15 +97,23 @@ | compute_resources.available_storage_pods | [GET /api/compute_resources/:id/available_storage_pods](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_storage_pods.html) | List storage pods for a compute resource | | compute_resources.available_zones | [GET /api/compute_resources/:id/available_zones](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_zones.html) | List available zone for a compute resource | | compute_resources.compute_attributes_compute_resource_id_compute_createprofiles | [POST /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/create.html) | Create a compute attributes set | +| compute_resources.compute_attributes_compute_resource_id_compute_indexprofiles | [GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/index.html) | List of compute attributes for provided compute profile and compute resource | +| compute_resources.compute_attributes_compute_resource_id_compute_showattributes | [GET /api/compute_resources/:compute_resource_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/show.html) | Show a compute attributes set | +| compute_resources.compute_attributes_compute_resource_id_compute_showprofiles | [GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/show.html) | Show a compute attributes set | | compute_resources.compute_attributes_compute_resource_id_compute_updateattributes | [PUT /api/compute_resources/:compute_resource_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/update.html) | Update a compute attributes set | | compute_resources.compute_attributes_compute_resource_id_compute_updateprofiles | [PUT /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/update.html) | Update a compute attributes set | | compute_resources.compute_attributes_create | [POST /api/compute_resources/:compute_resource_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/create.html) | Create a compute attributes set | +| compute_resources.compute_attributes_index | [GET /api/compute_resources/:compute_resource_id/compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/compute_attributes/index.html) | List of compute attributes for compute resource | | compute_resources.create | [POST /api/compute_resources](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/create.html) | Create a compute resource | | compute_resources.destroy | [DELETE /api/compute_resources/:id](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/destroy.html) | Delete a compute resource | | compute_resources.id_available_available_networksclusters | [GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_networks.html) | List available networks for a compute resource cluster | | compute_resources.id_available_available_resource_poolsclusters | [GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_resource_pools.html) | List resource pools for a compute resource cluster | +| compute_resources.id_available_available_storage_domainsclusters | [GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_storage_domains.html) | List storage domains for a compute resource | +| compute_resources.id_available_available_storage_podsclusters | [GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_storage_pods.html) | List storage pods for a compute resource | | compute_resources.id_available_storage_available_storage_domainsdomains | [GET /api/compute_resources/:id/available_storage_domains/:storage_domain](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_storage_domains.html) | List attributes for a given storage domain | | compute_resources.id_available_storage_available_storage_podspods | [GET /api/compute_resources/:id/available_storage_pods/:storage_pod](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/available_storage_pods.html) | List attributes for a given storage pod | +| compute_resources.id_storage_storage_domaindomains | [GET /api/compute_resources/:id/storage_domains/:storage_domain_id](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/storage_domain.html) | List attributes for a given storage domain | +| compute_resources.id_storage_storage_podpods | [GET /api/compute_resources/:id/storage_pods/:storage_pod_id](https://theforeman.org/api/1.16/apidoc/v2/compute_resources/storage_pod.html) | List attributes for a given storage pod | | compute_resources.images_compute_resource_id_destroyimages | [DELETE /api/compute_resources/:compute_resource_id/images/:id](https://theforeman.org/api/1.16/apidoc/v2/images/destroy.html) | Delete an image | | compute_resources.images_compute_resource_id_showimages | [GET /api/compute_resources/:compute_resource_id/images/:id](https://theforeman.org/api/1.16/apidoc/v2/images/show.html) | Show an image | | compute_resources.images_compute_resource_id_updateimages | [PUT /api/compute_resources/:compute_resource_id/images/:id](https://theforeman.org/api/1.16/apidoc/v2/images/update.html) | Update an image | @@ -159,13 +153,14 @@ | content_credentials.set_content | [POST /katello/api/content_credentials/:id/content](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_credentials/set_content.html) | Upload content credential contents | | content_credentials.show | [GET /katello/api/content_credentials/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_credentials/show.html) | Show a content credential | | content_credentials.update | [PUT /katello/api/content_credentials/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_credentials/update.html) | Update a content credential | +| content_view_filters.ansible_collections_index | [GET /katello/api/content_view_filters/:content_view_filter_id/ansible_collections](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/index.html) | List ansible_collections | | content_view_filters.content_view_filter_rules_create | [POST /katello/api/content_view_filters/:content_view_filter_id/rules](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filter_rules/create.html) | Create a filter rule. The parameters included should be based upon the filter type. | | content_view_filters.content_view_filter_rules_index | [GET /katello/api/content_view_filters/:content_view_filter_id/rules](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filter_rules/index.html) | List filter rules | | content_view_filters.content_view_filter_rules_ontent_view_destroyfilters | [DELETE /katello/api/content_view_filters/:content_view_filter_id/rules/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filter_rules/destroy.html) | Delete a filter rule | | content_view_filters.content_view_filter_rules_ontent_view_showfilters | [GET /katello/api/content_view_filters/:content_view_filter_id/rules/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filter_rules/show.html) | Show filter rule info | | content_view_filters.content_view_filter_rules_ontent_view_updatefilters | [PUT /katello/api/content_view_filters/:content_view_filter_id/rules/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filter_rules/update.html) | Update a filter rule. The parameters included should be based upon the filter type. | | content_view_filters.create | [post /katello/api/content_view_filters](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filters/create.html) | create a filter for a content view | -| content_view_filters.debs_index | [GET /katello/api/content_view_filters/:content_view_filter_id/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List debs | +| content_view_filters.debs_index | [GET /katello/api/content_view_filters/:content_view_filter_id/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List deb packages | | content_view_filters.destroy | [delete /katello/api/content_view_filters/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_filters/destroy.html) | delete a filter | | content_view_filters.docker_manifest_lists_index | [GET /katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/docker_manifest_lists/index.html) | List docker_manifest_lists | | content_view_filters.docker_manifests_index | [GET /katello/api/content_view_filters/:content_view_filter_id/docker_manifests](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/docker_manifests/index.html) | List docker_manifests | @@ -188,6 +183,7 @@ | content_view_versions.republish_repositories | [PUT /katello/api/content_view_versions/:id/republish_repositories](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_versions/republish_repositories.html) | Forces a republish of the version's repositories' metadata | | content_view_versions.show | [GET /katello/api/content_view_versions/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_versions/show.html) | Show content view version | | content_view_versions.update | [PUT /katello/api/content_view_versions/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_versions/update.html) | Update a content view version | +| content_views.ansible_collections_ontent_indexviews | [GET /katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/index.html) | List ansible_collections | | content_views.available_puppet_module_names | [GET /katello/api/content_views/:id/available_puppet_module_names](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/available_puppet_module_names.html) | Get puppet modules names that are available to be added to the content view | | content_views.available_puppet_modules | [GET /katello/api/content_views/:id/available_puppet_modules](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/available_puppet_modules.html) | Get puppet modules that are available to be added to the content view | | content_views.content_view_components_add_components | [PUT /katello/api/content_views/:composite_content_view_id/content_view_components/add](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_components/add_components.html) | Add components to the content view | @@ -209,7 +205,7 @@ | content_views.content_view_versions_index | [GET /katello/api/content_views/:content_view_id/content_view_versions](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_view_versions/index.html) | List content view versions | | content_views.copy | [POST /katello/api/content_views/:id/copy](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/copy.html) | Make copy of a content view | | content_views.create | [POST /katello/api/content_views](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/create.html) | Create a content view | -| content_views.debs_ontent_indexviews | [GET /katello/api/content_views/:content_view_id/filters/:filter_id/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List debs | +| content_views.debs_ontent_indexviews | [GET /katello/api/content_views/:content_view_id/filters/:filter_id/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List deb packages | | content_views.destroy | [DELETE /katello/api/content_views/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/destroy.html) | Delete a content view | | content_views.docker_manifest_lists_ontent_indexviews | [GET /katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/docker_manifest_lists/index.html) | List docker_manifest_lists | | content_views.docker_manifests_ontent_indexviews | [GET /katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/docker_manifests/index.html) | List docker_manifests | @@ -227,10 +223,11 @@ | content_views.repositories_index | [GET /katello/api/content_views/:id/repositories](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/index.html) | List of repositories for a content view | | content_views.show | [GET /katello/api/content_views/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/show.html) | Show a content view | | content_views.update | [PUT /katello/api/content_views/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_views/update.html) | Update a content view | +| current_user.users_show_current | [GET /api/current_user](https://theforeman.org/api/1.16/apidoc/v2/users/show_current.html) | Show the currently logged-in user | | dashboard.index | [GET /api/dashboard](https://theforeman.org/api/1.16/apidoc/v2/dashboard/index.html) | Get dashboard details | -| debs.compare | [GET /katello/api/debs/compare](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/compare.html) | List debs | -| debs.index | [GET /katello/api/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List debs | -| debs.show | [GET /katello/api/debs/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/show.html) | Show a deb | +| debs.compare | [GET /katello/api/debs/compare](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/compare.html) | List deb packages | +| debs.index | [GET /katello/api/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List deb packages | +| debs.show | [GET /katello/api/debs/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/show.html) | Show a deb package | | discovered_hosts.auto_provision | [POST /api/v2/discovered_hosts/:id/auto_provision](https://theforeman.org/api/1.16/apidoc/v2/discovered_hosts/auto_provision.html) | Execute rules against a discovered host | | discovered_hosts.auto_provision_all | [POST /api/v2/discovered_hosts/auto_provision_all](https://theforeman.org/api/1.16/apidoc/v2/discovered_hosts/auto_provision_all.html) | Execute rules against all currently discovered hosts | | discovered_hosts.create | [POST /api/v2/discovered_hosts](https://theforeman.org/api/1.16/apidoc/v2/discovered_hosts/create.html) | Create a discovered host for testing (use /facts to create new hosts) | @@ -272,7 +269,7 @@ | environments.activation_keys_index | [GET /katello/api/environments/:environment_id/activation_keys](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/activation_keys/index.html) | | | environments.create | [POST /api/environments](https://theforeman.org/api/1.16/apidoc/v2/environments/create.html) | Create an environment | | environments.destroy | [DELETE /api/environments/:id](https://theforeman.org/api/1.16/apidoc/v2/environments/destroy.html) | Delete an environment | -| environments.environment_id_smart_import_puppetclassesproxies | [POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/environments/import_puppetclasses.html) | Import puppet classes from puppet Capsule for an environment | +| environments.environment_id_smart_import_puppetclassesproxies | [POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/environments/import_puppetclasses.html) | Import puppet classes from puppet proxy for an environment | | environments.hosts_index | [GET /api/environments/:environment_id/hosts](https://theforeman.org/api/1.16/apidoc/v2/hosts/index.html) | List hosts per environment | | environments.index | [GET /api/environments](https://theforeman.org/api/1.16/apidoc/v2/environments/index.html) | List all environments | | environments.lifecycle_environments_create | [POST /katello/api/environments](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/lifecycle_environments/create.html) | Create an environment | @@ -286,7 +283,7 @@ | environments.show | [GET /api/environments/:id](https://theforeman.org/api/1.16/apidoc/v2/environments/show.html) | Show an environment | | environments.smart_class_parameters_environment_id_indexpuppetclasses | [GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters](https://theforeman.org/api/1.16/apidoc/v2/smart_class_parameters/index.html) | List of smart class parameters for a specific environment/Puppet class combination | | environments.smart_class_parameters_index | [GET /api/environments/:environment_id/smart_class_parameters](https://theforeman.org/api/1.16/apidoc/v2/smart_class_parameters/index.html) | List of smart class parameters for a specific environment | -| environments.smart_proxies_environment_id_smart_import_puppetclassesproxies | [POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/import_puppetclasses.html) | Import puppet classes from puppet Capsule for an environment | +| environments.smart_proxies_environment_id_smart_import_puppetclassesproxies | [POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/import_puppetclasses.html) | Import puppet classes from puppet proxy for an environment | | environments.template_combinations_create | [POST /api/environments/:environment_id/template_combinations](https://theforeman.org/api/1.16/apidoc/v2/template_combinations/create.html) | Add a template combination | | environments.template_combinations_environment_id_template_showcombinations | [GET /api/environments/:environment_id/template_combinations/:id](https://theforeman.org/api/1.16/apidoc/v2/template_combinations/show.html) | Show template combination | | environments.template_combinations_environment_id_template_updatecombinations | [PUT /api/environments/:environment_id/template_combinations/:id](https://theforeman.org/api/1.16/apidoc/v2/template_combinations/update.html) | Update template combination | @@ -296,7 +293,7 @@ | errata.index | [GET /katello/api/errata](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/errata/index.html) | List errata | | errata.show | [GET /katello/api/errata/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/errata/show.html) | Show an erratum | | fact_values.index | [GET /api/fact_values](https://theforeman.org/api/1.16/apidoc/v2/fact_values/index.html) | List all fact values | -| files.file_units_compare | [GET /katello/api/files/compare](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/file_units/compare.html) | List files | +| files.file_units_compare | [GET /katello/api/files/compare](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/file_units/compare.html) | List :resource | | files.file_units_index | [GET /katello/api/files](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/file_units/index.html) | List files | | files.file_units_show | [GET /katello/api/files/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/file_units/show.html) | Show a file | | filters.create | [POST /api/filters](https://theforeman.org/api/1.16/apidoc/v2/filters/create.html) | Create a filter | @@ -320,6 +317,7 @@ | host_collections.show | [GET /katello/api/host_collections/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/host_collections/show.html) | Show a host collection | | host_collections.update | [PUT /katello/api/host_collections/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/host_collections/update.html) | Update a host collection | | hostgroups.ansible_roles | [GET /api/hostgroups/:id/ansible_roles](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/ansible_roles.html) | List all Ansible roles for a hostgroup | +| hostgroups.assign_ansible_roles | [POST /api/hostgroups/:id/assign_ansible_roles](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/assign_ansible_roles.html) | Assigns Ansible roles to a hostgroup | | hostgroups.clone | [POST /api/hostgroups/:id/clone](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/clone.html) | Clone a host group | | hostgroups.create | [POST /api/hostgroups](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/create.html) | Create a host group | | hostgroups.destroy | [DELETE /api/hostgroups/:id](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/destroy.html) | Delete a host group | @@ -328,14 +326,14 @@ | hostgroups.hostgroup_classes_index | [GET /api/hostgroups/:hostgroup_id/puppetclass_ids](https://theforeman.org/api/1.16/apidoc/v2/hostgroup_classes/index.html) | List all Puppet class IDs for host group | | hostgroups.hosts_index | [GET /api/hostgroups/:hostgroup_id/hosts](https://theforeman.org/api/1.16/apidoc/v2/hosts/index.html) | List all hosts for a host group | | hostgroups.index | [GET /api/hostgroups](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/index.html) | List all host groups | -| hostgroups.multiple_play_roles | [POST /api/hostgroups/multiple_play_roles](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/multiple_play_roles.html) | Plays Ansible roles on hostgroups | +| hostgroups.multiple_play_roles | [POST /api/hostgroups/multiple_play_roles](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/multiple_play_roles.html) | Runs all Ansible roles on hostgroups | | hostgroups.parameters_create | [POST /api/hostgroups/:hostgroup_id/parameters](https://theforeman.org/api/1.16/apidoc/v2/parameters/create.html) | Create a nested parameter for a host group | | hostgroups.parameters_hostgroup_id_destroyparameters | [DELETE /api/hostgroups/:hostgroup_id/parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/parameters/destroy.html) | Delete a nested parameter for a host group | | hostgroups.parameters_hostgroup_id_showparameters | [GET /api/hostgroups/:hostgroup_id/parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/parameters/show.html) | Show a nested parameter for a host group | | hostgroups.parameters_hostgroup_id_updateparameters | [PUT /api/hostgroups/:hostgroup_id/parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/parameters/update.html) | Update a nested parameter for a host group | | hostgroups.parameters_index | [GET /api/hostgroups/:hostgroup_id/parameters](https://theforeman.org/api/1.16/apidoc/v2/parameters/index.html) | List all parameters for a host group | | hostgroups.parameters_reset | [DELETE /api/hostgroups/:hostgroup_id/parameters](https://theforeman.org/api/1.16/apidoc/v2/parameters/reset.html) | Delete all nested parameters for a host group | -| hostgroups.play_roles | [POST /api/hostgroups/:id/play_roles](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/play_roles.html) | Plays Ansible roles on a hostgroup | +| hostgroups.play_roles | [POST /api/hostgroups/:id/play_roles](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/play_roles.html) | Runs all Ansible roles on a hostgroup | | hostgroups.puppetclasses_hostgroup_id_showpuppetclasses | [GET /api/hostgroups/:hostgroup_id/puppetclasses/:id](https://theforeman.org/api/1.16/apidoc/v2/puppetclasses/show.html) | Show a Puppet class for a host group | | hostgroups.puppetclasses_index | [GET /api/hostgroups/:hostgroup_id/puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/puppetclasses/index.html) | List all Puppet classes for a host group | | hostgroups.rebuild_config | [PUT /api/hostgroups/:id/rebuild_config](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/rebuild_config.html) | Rebuild orchestration config | @@ -348,6 +346,7 @@ | hostgroups.template_combinations_index | [GET /api/hostgroups/:hostgroup_id/template_combinations](https://theforeman.org/api/1.16/apidoc/v2/template_combinations/index.html) | List template combination | | hostgroups.update | [PUT /api/hostgroups/:id](https://theforeman.org/api/1.16/apidoc/v2/hostgroups/update.html) | Update a host group | | hosts.ansible_roles | [GET /api/hosts/:id/ansible_roles](https://theforeman.org/api/1.16/apidoc/v2/hosts/ansible_roles.html) | List all Ansible roles for a host | +| hosts.assign_ansible_roles | [POST /api/hosts/:id/assign_ansible_roles](https://theforeman.org/api/1.16/apidoc/v2/hosts/assign_ansible_roles.html) | Assigns Ansible roles to a host | | hosts.audits_index | [GET /api/hosts/:host_id/audits](https://theforeman.org/api/1.16/apidoc/v2/audits/index.html) | List all audits for a given host | | hosts.boot | [PUT /api/hosts/:id/boot](https://theforeman.org/api/1.16/apidoc/v2/hosts/boot.html) | Boot host from specified device | | hosts.config_reports_last | [GET /api/hosts/:host_id/config_reports/last](https://theforeman.org/api/1.16/apidoc/v2/config_reports/last.html) | Show the last report for a host | @@ -361,6 +360,7 @@ | hosts.host_classes_host_id_puppetclass_destroyids | [DELETE /api/hosts/:host_id/puppetclass_ids/:id](https://theforeman.org/api/1.16/apidoc/v2/host_classes/destroy.html) | Remove a Puppet class from host | | hosts.host_classes_index | [GET /api/hosts/:host_id/puppetclass_ids](https://theforeman.org/api/1.16/apidoc/v2/host_classes/index.html) | List all Puppet class IDs for host | | hosts.host_collections | [PUT /api/hosts/:host_id/host_collections](https://theforeman.org/api/1.16/apidoc/v2/hosts/host_collections.html) | Alter a hosts host collections | +| hosts.host_debs_index | [GET /api/hosts/:host_id/debs](https://theforeman.org/api/1.16/apidoc/v2/host_debs/index.html) | List deb packages installed on the host | | hosts.host_errata_applicability | [PUT /api/hosts/:host_id/errata/applicability](https://theforeman.org/api/1.16/apidoc/v2/host_errata/applicability.html) | Force regenerate applicability. | | hosts.host_errata_apply | [PUT /api/hosts/:host_id/errata/apply](https://theforeman.org/api/1.16/apidoc/v2/host_errata/apply.html) | Schedule errata for installation | | hosts.host_errata_host_id_showerrata | [GET /api/hosts/:host_id/errata/:id](https://theforeman.org/api/1.16/apidoc/v2/host_errata/show.html) | Retrieve a single errata for a host | @@ -406,15 +406,16 @@ | hosts.interfaces_host_id_showinterfaces | [GET /api/hosts/:host_id/interfaces/:id](https://theforeman.org/api/1.16/apidoc/v2/interfaces/show.html) | Show an interface for host | | hosts.interfaces_host_id_updateinterfaces | [PUT /api/hosts/:host_id/interfaces/:id](https://theforeman.org/api/1.16/apidoc/v2/interfaces/update.html) | Update a host's interface | | hosts.interfaces_index | [GET /api/hosts/:host_id/interfaces](https://theforeman.org/api/1.16/apidoc/v2/interfaces/index.html) | List all interfaces for host | -| hosts.multiple_play_roles | [POST /api/hosts/multiple_play_roles](https://theforeman.org/api/1.16/apidoc/v2/hosts/multiple_play_roles.html) | Plays Ansible roles on hosts | +| hosts.multiple_play_roles | [POST /api/hosts/multiple_play_roles](https://theforeman.org/api/1.16/apidoc/v2/hosts/multiple_play_roles.html) | Runs all Ansible roles on hosts | | hosts.parameters_create | [POST /api/hosts/:host_id/parameters](https://theforeman.org/api/1.16/apidoc/v2/parameters/create.html) | Create a nested parameter for a host | | hosts.parameters_host_id_destroyparameters | [DELETE /api/hosts/:host_id/parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/parameters/destroy.html) | Delete a nested parameter for a host | | hosts.parameters_host_id_showparameters | [GET /api/hosts/:host_id/parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/parameters/show.html) | Show a nested parameter for a host | | hosts.parameters_host_id_updateparameters | [PUT /api/hosts/:host_id/parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/parameters/update.html) | Update a nested parameter for a host | | hosts.parameters_index | [GET /api/hosts/:host_id/parameters](https://theforeman.org/api/1.16/apidoc/v2/parameters/index.html) | List all parameters for a host | | hosts.parameters_reset | [DELETE /api/hosts/:host_id/parameters](https://theforeman.org/api/1.16/apidoc/v2/parameters/reset.html) | Delete all nested parameters for a host | -| hosts.play_roles | [POST /api/hosts/:id/play_roles](https://theforeman.org/api/1.16/apidoc/v2/hosts/play_roles.html) | Plays Ansible roles on a host | +| hosts.play_roles | [POST /api/hosts/:id/play_roles](https://theforeman.org/api/1.16/apidoc/v2/hosts/play_roles.html) | Runs all Ansible roles on a host | | hosts.power | [PUT /api/hosts/:id/power](https://theforeman.org/api/1.16/apidoc/v2/hosts/power.html) | Run a power operation on host | +| hosts.power_status | [GET /api/hosts/:id/power](https://theforeman.org/api/1.16/apidoc/v2/hosts/power_status.html) | Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs. | | hosts.puppet_hosts_puppetrun | [PUT /api/hosts/:id/puppetrun](https://theforeman.org/api/1.16/apidoc/v2/puppet_hosts/puppetrun.html) | Force a Puppet agent run on the host | | hosts.puppetclasses_host_id_showpuppetclasses | [GET /api/hosts/:host_id/puppetclasses/:id](https://theforeman.org/api/1.16/apidoc/v2/puppetclasses/show.html) | Show a Puppet class for host | | hosts.puppetclasses_index | [GET /api/hosts/:host_id/puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/puppetclasses/index.html) | List all Puppet classes for a host | @@ -423,6 +424,12 @@ | hosts.show | [GET /api/hosts/:id](https://theforeman.org/api/1.16/apidoc/v2/hosts/show.html) | Show a host | | hosts.smart_class_parameters_index | [GET /api/hosts/:host_id/smart_class_parameters](https://theforeman.org/api/1.16/apidoc/v2/smart_class_parameters/index.html) | List of smart class parameters for a specific host | | hosts.smart_variables_index | [GET /api/hosts/:host_id/smart_variables](https://theforeman.org/api/1.16/apidoc/v2/smart_variables/index.html) | List of smart variables for a specific host | +| hosts.snapshots_create | [POST /api/hosts/:host_id/snapshots](https://theforeman.org/api/1.16/apidoc/v2/snapshots/create.html) | Create a snapshot | +| hosts.snapshots_host_id_destroysnapshots | [DELETE /api/hosts/:host_id/snapshots/:id](https://theforeman.org/api/1.16/apidoc/v2/snapshots/destroy.html) | Delete a snapshot | +| hosts.snapshots_host_id_revertsnapshots | [PUT /api/hosts/:host_id/snapshots/:id/revert](https://theforeman.org/api/1.16/apidoc/v2/snapshots/revert.html) | Revert Host to a snapshot | +| hosts.snapshots_host_id_showsnapshots | [GET /api/hosts/:host_id/snapshots/:id](https://theforeman.org/api/1.16/apidoc/v2/snapshots/show.html) | Show a snapshot | +| hosts.snapshots_host_id_updatesnapshots | [PUT /api/hosts/:host_id/snapshots/:id](https://theforeman.org/api/1.16/apidoc/v2/snapshots/update.html) | Update a snapshot | +| hosts.snapshots_index | [GET /api/hosts/:host_id/snapshots](https://theforeman.org/api/1.16/apidoc/v2/snapshots/index.html) | List all snapshots | | hosts.status | [GET /api/hosts/:id/status](https://theforeman.org/api/1.16/apidoc/v2/hosts/status.html) | Get configuration status of host | | hosts.update | [PUT /api/hosts/:id](https://theforeman.org/api/1.16/apidoc/v2/hosts/update.html) | Update a host | | hosts.vm_compute_attributes | [GET /api/hosts/:id/vm_compute_attributes](https://theforeman.org/api/1.16/apidoc/v2/hosts/vm_compute_attributes.html) | Get vm attributes of host | @@ -588,12 +595,14 @@ | permissions.index | [GET /api/permissions](https://theforeman.org/api/1.16/apidoc/v2/permissions/index.html) | List all permissions | | permissions.resource_types | [GET /api/permissions/resource_types](https://theforeman.org/api/1.16/apidoc/v2/permissions/resource_types.html) | List available resource types | | permissions.show | [GET /api/permissions/:id](https://theforeman.org/api/1.16/apidoc/v2/permissions/show.html) | Show a permission | -| ping.index | [GET /katello/api/ping](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ping/index.html) | Shows status of system and it's subcomponents | +| ping.index | [GET /katello/api/ping](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ping/index.html) | Shows status of orcharhino system and it's subcomponents | +| ping.ping | [GET /api/ping](https://theforeman.org/api/1.16/apidoc/v2/ping/ping.html) | Shows status of orcharhino system and it's subcomponents | | products.create | [POST /katello/api/products](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products/create.html) | Create a product | | products.destroy | [DELETE /katello/api/products/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products/destroy.html) | Destroy a product | | products.index | [GET /katello/api/products](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products/index.html) | List products | | products.products_bulk_actions_destroy_products | [PUT /katello/api/products/bulk/destroy](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products_bulk_actions/destroy_products.html) | Destroy one or more products | | products.products_bulk_actions_sync_products | [PUT /katello/api/products/bulk/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products_bulk_actions/sync_products.html) | Sync one or more products | +| products.products_bulk_actions_update_http_proxy | [PUT /katello/api/products/bulk/http_proxy](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products_bulk_actions/update_http_proxy.html) | Update the http proxy configuration on the repositories of one or more products. | | products.products_bulk_actions_update_sync_plans | [PUT /katello/api/products/bulk/sync_plan](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/products_bulk_actions/update_sync_plans.html) | Sync one or more products | | products.repositories_index | [GET /katello/api/products/:product_id/repositories](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/index.html) | List of repositories for a product | | products.repository_sets_index | [GET /katello/api/products/:product_id/repository_sets](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repository_sets/index.html) | List repository sets for a product. | @@ -651,21 +660,25 @@ | report_templates.create | [POST /api/report_templates](https://theforeman.org/api/1.16/apidoc/v2/report_templates/create.html) | Create a report template | | report_templates.destroy | [DELETE /api/report_templates/:id](https://theforeman.org/api/1.16/apidoc/v2/report_templates/destroy.html) | Delete a report template | | report_templates.export | [GET /api/report_templates/:id/export](https://theforeman.org/api/1.16/apidoc/v2/report_templates/export.html) | Export a report template to ERB | -| report_templates.generate | [POST /api/report_templates/:id/generate](https://theforeman.org/api/1.16/apidoc/v2/report_templates/generate.html) | Generate a report template | +| report_templates.generate | [POST /api/report_templates/:id/generate](https://theforeman.org/api/1.16/apidoc/v2/report_templates/generate.html) | Generate report from a template | +| report_templates.id_report_report_datadata | [GET /api/report_templates/:id/report_data/:job_id](https://theforeman.org/api/1.16/apidoc/v2/report_templates/report_data.html) | Downloads a generated report | | report_templates.import_ | [POST /api/report_templates/import](https://theforeman.org/api/1.16/apidoc/v2/report_templates/import.html) | Import a report template | | report_templates.index | [GET /api/report_templates](https://theforeman.org/api/1.16/apidoc/v2/report_templates/index.html) | List all report templates | | report_templates.revision | [GET /api/report_templates/revision](https://theforeman.org/api/1.16/apidoc/v2/report_templates/revision.html) | | +| report_templates.schedule_report | [POST /api/report_templates/:id/schedule_report](https://theforeman.org/api/1.16/apidoc/v2/report_templates/schedule_report.html) | Schedule generating of a report | | report_templates.show | [GET /api/report_templates/:id](https://theforeman.org/api/1.16/apidoc/v2/report_templates/show.html) | Show a report template | | report_templates.update | [PUT /api/report_templates/:id](https://theforeman.org/api/1.16/apidoc/v2/report_templates/update.html) | Update a report template | | reports.create | [POST /api/reports](https://theforeman.org/api/1.16/apidoc/v2/reports/create.html) | Create a report | | reports.destroy | [DELETE /api/reports/:id](https://theforeman.org/api/1.16/apidoc/v2/reports/destroy.html) | Delete a report | | reports.index | [GET /api/reports](https://theforeman.org/api/1.16/apidoc/v2/reports/index.html) | List all reports | | reports.show | [GET /api/reports/:id](https://theforeman.org/api/1.16/apidoc/v2/reports/show.html) | Show a report | +| repositories.ansible_collections_epositories | [GET /katello/api/repositories/:repository_id/ansible_collections/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/show.html) | Show an ansible collection | +| repositories.ansible_collections_index | [GET /katello/api/repositories/:repository_id/ansible_collections](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ansible_collections/index.html) | List ansible_collections | | repositories.content_uploads_create | [POST /katello/api/repositories/:repository_id/content_uploads](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_uploads/create.html) | Create an upload request | | repositories.content_uploads_epositories | [PUT /katello/api/repositories/:repository_id/content_uploads/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/content_uploads/update.html) | Upload a chunk of the file's content | | repositories.create | [POST /katello/api/repositories](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/create.html) | Create a custom repository | -| repositories.debs_epositories | [GET /katello/api/repositories/:repository_id/debs/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/show.html) | Show a deb | -| repositories.debs_index | [GET /katello/api/repositories/:repository_id/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List debs | +| repositories.debs_epositories | [GET /katello/api/repositories/:repository_id/debs/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/show.html) | Show a deb package | +| repositories.debs_index | [GET /katello/api/repositories/:repository_id/debs](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/debs/index.html) | List deb packages | | repositories.destroy | [DELETE /katello/api/repositories/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/destroy.html) | Destroy a custom repository | | repositories.docker_manifest_lists_epositories | [GET /katello/api/repositories/:repository_id/docker_manifest_lists/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/docker_manifest_lists/show.html) | Show a docker manifest list | | repositories.docker_manifest_lists_index | [GET /katello/api/repositories/:repository_id/docker_manifest_lists](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/docker_manifest_lists/index.html) | List docker_manifest_lists | @@ -695,6 +708,7 @@ | repositories.repository_types | [GET /katello/api/repositories/repository_types](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/repository_types.html) | Show the available repository types | | repositories.republish | [PUT /katello/api/repositories/:id/republish](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/republish.html) | Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem. | | repositories.show | [GET /katello/api/repositories/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/show.html) | Show a repository | +| repositories.srpms_epositories | [GET /katello/api/repositories/:repository_id/srpms/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/srpms/show.html) | Show SRPM details | | repositories.sync | [POST /katello/api/repositories/:id/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/sync.html) | Sync a repository | | repositories.sync_index | [GET /katello/api/repositories/:repository_id/sync](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/sync/index.html) | Get status of synchronisation for given repository | | repositories.update | [PUT /katello/api/repositories/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/repositories/update.html) | Update a repository | @@ -711,6 +725,17 @@ | roles.show | [GET /api/roles/:id](https://theforeman.org/api/1.16/apidoc/v2/roles/show.html) | Show a role | | roles.update | [PUT /api/roles/:id](https://theforeman.org/api/1.16/apidoc/v2/roles/update.html) | Update a role | | roles.users_index | [GET /api/roles/:role_id/users](https://theforeman.org/api/1.16/apidoc/v2/users/index.html) | List all users for role | +| scc_accounts.bulk_subscribe | [PUT /api/v2/scc_accounts/:id/bulk_subscribe](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/bulk_subscribe.html) | Bulk subscription of scc_products for scc_account | +| scc_accounts.create | [POST /api/v2/scc_accounts](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/create.html) | Create an scc_account | +| scc_accounts.destroy | [DELETE /api/v2/scc_accounts/:id](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/destroy.html) | Delete scc_account | +| scc_accounts.index | [GET /api/v2/scc_accounts](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/index.html) | List all scc_accounts | +| scc_accounts.scc_products_cc_showaccounts | [GET /api/v2/scc_accounts/:scc_account_id/scc_products/:id](https://theforeman.org/api/1.16/apidoc/v2/scc_products/show.html) | Show an scc_account product | +| scc_accounts.scc_products_cc_subscribeaccounts | [PUT /api/v2/scc_accounts/:scc_account_id/scc_products/:id/subscribe](https://theforeman.org/api/1.16/apidoc/v2/scc_products/subscribe.html) | Subscribe product | +| scc_accounts.scc_products_index | [GET /api/v2/scc_accounts/:scc_account_id/scc_products](https://theforeman.org/api/1.16/apidoc/v2/scc_products/index.html) | List all products for scc_account | +| scc_accounts.show | [GET /api/v2/scc_accounts/:id](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/show.html) | Show scc_account | +| scc_accounts.sync | [PUT /api/v2/scc_accounts/:id/sync](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/sync.html) | Sync scc_account | +| scc_accounts.test_connection | [POST /api/v2/scc_accounts/test_connection](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/test_connection.html) | Test connection for scc_account | +| scc_accounts.update | [PUT /api/v2/scc_accounts/:id](https://theforeman.org/api/1.16/apidoc/v2/scc_accounts/update.html) | Update scc_account | | settings.index | [GET /api/settings](https://theforeman.org/api/1.16/apidoc/v2/settings/index.html) | List all settings | | settings.show | [GET /api/settings/:id](https://theforeman.org/api/1.16/apidoc/v2/settings/show.html) | Show a setting | | settings.update | [PUT /api/settings/:id](https://theforeman.org/api/1.16/apidoc/v2/settings/update.html) | Update a setting | @@ -723,18 +748,18 @@ | smart_class_parameters.show | [GET /api/smart_class_parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_class_parameters/show.html) | Show a smart class parameter | | smart_class_parameters.update | [PUT /api/smart_class_parameters/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_class_parameters/update.html) | Update a smart class parameter | | smart_proxies.autosign_create | [POST /api/smart_proxies/:smart_proxy_id/autosign](https://theforeman.org/api/1.16/apidoc/v2/autosign/create.html) | Create autosign entry | -| smart_proxies.autosign_index | [GET /api/smart_proxies/smart_proxy_id/autosign](https://theforeman.org/api/1.16/apidoc/v2/autosign/index.html) | List all autosign entries | +| smart_proxies.autosign_index | [GET /api/smart_proxies/:smart_proxy_id/autosign](https://theforeman.org/api/1.16/apidoc/v2/autosign/index.html) | List all autosign entries | | smart_proxies.autosign_smart_proxy_id_destroyautosign | [DELETE /api/smart_proxies/:smart_proxy_id/autosign/:id](https://theforeman.org/api/1.16/apidoc/v2/autosign/destroy.html) | Delete autosign entry | -| smart_proxies.create | [POST /api/smart_proxies](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/create.html) | Create a capsule | -| smart_proxies.destroy | [DELETE /api/smart_proxies/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/destroy.html) | Delete a capsule | -| smart_proxies.environments_import_puppetclasses | [POST /api/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/environments/import_puppetclasses.html) | Import puppet classes from puppet Capsule | -| smart_proxies.environments_smart_proxy_id_import_puppetclassesenvironments | [POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/environments/import_puppetclasses.html) | Import puppet classes from puppet Capsule for an environment | -| smart_proxies.import_puppetclasses | [POST /api/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/import_puppetclasses.html) | Import puppet classes from puppet Capsule | -| smart_proxies.index | [GET /api/smart_proxies](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/index.html) | List all capsules | -| smart_proxies.refresh | [PUT /api/smart_proxies/:id/refresh](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/refresh.html) | Refresh capsule features | -| smart_proxies.show | [GET /api/smart_proxies/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/show.html) | Show a capsule | -| smart_proxies.smart_proxy_id_import_puppetclassesenvironments | [POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/import_puppetclasses.html) | Import puppet classes from puppet Capsule for an environment | -| smart_proxies.update | [PUT /api/smart_proxies/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/update.html) | Update a capsule | +| smart_proxies.create | [POST /api/smart_proxies](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/create.html) | Create a smart proxy | +| smart_proxies.destroy | [DELETE /api/smart_proxies/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/destroy.html) | Delete a smart proxy | +| smart_proxies.environments_import_puppetclasses | [POST /api/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/environments/import_puppetclasses.html) | Import puppet classes from puppet proxy | +| smart_proxies.environments_smart_proxy_id_import_puppetclassesenvironments | [POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/environments/import_puppetclasses.html) | Import puppet classes from puppet proxy for an environment | +| smart_proxies.import_puppetclasses | [POST /api/smart_proxies/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/import_puppetclasses.html) | Import puppet classes from puppet proxy | +| smart_proxies.index | [GET /api/smart_proxies](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/index.html) | List all smart proxies | +| smart_proxies.refresh | [PUT /api/smart_proxies/:id/refresh](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/refresh.html) | Refresh smart proxy features | +| smart_proxies.show | [GET /api/smart_proxies/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/show.html) | Show a smart proxy | +| smart_proxies.smart_proxy_id_import_puppetclassesenvironments | [POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/import_puppetclasses.html) | Import puppet classes from puppet proxy for an environment | +| smart_proxies.update | [PUT /api/smart_proxies/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_proxies/update.html) | Update a smart proxy | | smart_variables.create | [POST /api/smart_variables](https://theforeman.org/api/1.16/apidoc/v2/smart_variables/create.html) | Create a smart variable | | smart_variables.destroy | [DELETE /api/smart_variables/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_variables/destroy.html) | Delete a smart variable | | smart_variables.index | [GET /api/smart_variables](https://theforeman.org/api/1.16/apidoc/v2/smart_variables/index.html) | List all smart variables | @@ -745,9 +770,13 @@ | smart_variables.override_values_smart_variable_id_override_updatevalues | [PUT /api/smart_variables/:smart_variable_id/override_values/:id](https://theforeman.org/api/1.16/apidoc/v2/override_values/update.html) | Update an override value for a specific smart variable | | smart_variables.show | [GET /api/smart_variables/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_variables/show.html) | Show a smart variable | | smart_variables.update | [PUT /api/smart_variables/:id](https://theforeman.org/api/1.16/apidoc/v2/smart_variables/update.html) | Update a smart variable | +| srpms.compare | [GET /katello/api/srpms/compare](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/srpms/compare.html) | List srpms | +| srpms.index | [GET /katello/api/srpms](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/srpms/index.html) | List srpms | +| srpms.show | [GET /katello/api/srpms/:id](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/srpms/show.html) | Show SRPM details | | statistics.index | [GET /api/statistics](https://theforeman.org/api/1.16/apidoc/v2/statistics/index.html) | Get statistics | | status.home_status | [GET /api/status](https://theforeman.org/api/1.16/apidoc/v2/home/status.html) | Show status | | status.ping_server_status | [GET /katello/api/status](https://theforeman.org/plugins/katello/3.4/api/apidoc/v2/ping/server_status.html) | Shows version information | +| statuses.ping_statuses | [GET /api/statuses](https://theforeman.org/api/1.16/apidoc/v2/ping/statuses.html) | Shows status and version information of orcharhino system and it's subcomponents | | subnets.create | [POST /api/subnets](https://theforeman.org/api/1.16/apidoc/v2/subnets/create.html) | Create a subnet | | subnets.destroy | [DELETE /api/subnets/:id](https://theforeman.org/api/1.16/apidoc/v2/subnets/destroy.html) | Delete a subnet | | subnets.domains_index | [GET /api/subnets/:subnet_id/domains](https://theforeman.org/api/1.16/apidoc/v2/domains/index.html) | List of domains per subnet | diff --git a/etc/api_definitions_2021_06_08/definitions/1.24.3-v2.json b/etc/api_definitions_2021_06_08/definitions/1.24.3-v2.json new file mode 100644 index 0000000..e385d34 --- /dev/null +++ b/etc/api_definitions_2021_06_08/definitions/1.24.3-v2.json @@ -0,0 +1,74710 @@ +{ + "docs": { + "name": "Foreman", + "info": "\n

foreman API v2 is currently the default API version.

\n", + "copyright": "", + "doc_url": "../apidoc/v2", + "api_url": "/api", + "resources": { + "host_subscriptions": { + "doc_url": "../apidoc/v2/host_subscriptions", + "api_url": "/api", + "name": "Host subscriptions", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_subscriptions/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions", + "http_method": "GET", + "short_description": "List a host's subscriptions", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/auto_attach", + "name": "auto_attach", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/auto_attach", + "http_method": "PUT", + "short_description": "Trigger an auto-attach of subscriptions", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/events", + "name": "events", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/events", + "http_method": "GET", + "short_description": "List subscription events for the host", + "deprecated": true + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions", + "http_method": "DELETE", + "short_description": "Unregister the host as a subscription consumer", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hosts/subscriptions", + "http_method": "POST", + "short_description": "Register a host with subscription and information", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "name", + "full_name": "name", + "description": "\n

Name of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "uuid", + "description": "\n

UUID to use for registered host, random uuid is generated if not provided

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "facts", + "full_name": "facts", + "description": "\n

Key-value hash of subscription-manager facts, nesting uses a period\ndelimiter (.)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_guest_uuids", + "full_name": "hypervisor_guest_uuids", + "description": "\n

UUIDs of the virtual guests from the host's hypervisor

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "installed_products", + "full_name": "installed_products", + "description": "\n

List of products installed on the host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "product_id", + "full_name": "installed_products[product_id]", + "description": "\n

Product id as listed from a host's installed products, this is\nnot the same product id as the products api returns

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_name", + "full_name": "installed_products[product_name]", + "description": "\n

Product name as listed from a host's installed products

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "arch", + "full_name": "installed_products[arch]", + "description": "\n

Product architecture

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "installed_products[version]", + "description": "\n

Product version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "release_version", + "full_name": "release_version", + "description": "\n

Release version of the content host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "service_level", + "full_name": "service_level", + "description": "\n

A service level for auto-healing process, e.g. SELF-SUPPORT

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lifecycle_environment_id", + "full_name": "lifecycle_environment_id", + "description": "\n

Lifecycle Environment ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

Content View ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/remove_subscriptions", + "name": "remove_subscriptions", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/remove_subscriptions", + "http_method": "PUT", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to remove

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "subscriptions[quantity]", + "description": "\n

If specified, remove the first instance of a subscription with matching id\nand quantity

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/add_subscriptions", + "name": "add_subscriptions", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/add_subscriptions", + "http_method": "PUT", + "short_description": "Add a subscription to a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "subscriptions[quantity]", + "description": "\n

Quantity of this subscriptions to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/content_override", + "name": "content_override", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/content_override", + "http_method": "PUT", + "short_description": "Set content overrides for the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the content host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_label", + "full_name": "content_label", + "description": "\n

Label of the content

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "value", + "description": "\n

Override to a boolean value or 'default'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_overrides", + "full_name": "content_overrides", + "description": "\n

Array of Content override parameters

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_label", + "full_name": "content_overrides[content_label]", + "description": "\n

Label of the content

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "content_overrides[value]", + "description": "\n

Override value. Provide a boolean value if name is 'enabled'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "content_overrides[name]", + "description": "\n

Override key or name. Note if name is not provided the default name will be\n'enabled'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "remove", + "full_name": "content_overrides[remove]", + "description": "\n

Set true to remove an override and reset it to 'default'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/product_content", + "name": "product_content", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/product_content", + "http_method": "GET", + "short_description": "Get content and overrides for the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Id of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_access_mode_all", + "full_name": "content_access_mode_all", + "description": "\n

Get all content available, not just that provided by subscriptions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_access_mode_env", + "full_name": "content_access_mode_env", + "description": "\n

Limit content to just that available in the host's content view version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_subscriptions/available_release_versions", + "name": "available_release_versions", + "apis": [ + { + "api_url": "/api/hosts/:host_id/subscriptions/available_release_versions", + "http_method": "GET", + "short_description": "Show releases available for the content host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

id of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "hosts": { + "doc_url": "../apidoc/v2/hosts", + "api_url": "/api", + "name": "Hosts", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/hosts/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts", + "http_method": "GET", + "short_description": "List all hosts", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/hosts", + "http_method": "GET", + "short_description": "List all hosts for a host group", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/hosts", + "http_method": "GET", + "short_description": "List hosts per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/hosts", + "http_method": "GET", + "short_description": "List hosts per organization", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/hosts", + "http_method": "GET", + "short_description": "List hosts per environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "thin", + "full_name": "thin", + "description": "\n

Only list ID and name of hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include", + "full_name": "include", + "description": "\n

Array of extra information types to include

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: parameters, all_parameters.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "activation_key", + "type": "string" + }, + { + "name": "activation_key_id", + "type": "string" + }, + { + "name": "addon", + "type": "string" + }, + { + "name": "addons_status", + "values": [ + "mismatched", + "matched", + "not_specified" + ] + }, + { + "name": "applicable_debs", + "type": "string" + }, + { + "name": "applicable_errata", + "type": "string" + }, + { + "name": "applicable_rpms", + "type": "string" + }, + { + "name": "architecture", + "type": "string" + }, + { + "name": "autoheal", + "type": "boolean" + }, + { + "name": "available_module_stream_name", + "type": "string" + }, + { + "name": "available_module_stream_stream", + "type": "string" + }, + { + "name": "boot_time", + "type": "" + }, + { + "name": "build", + "values": [ + "true", + "false" + ] + }, + { + "name": "class", + "type": "string" + }, + { + "name": "comment", + "type": "text" + }, + { + "name": "compute_resource", + "type": "string" + }, + { + "name": "compute_resource_id", + "type": "integer" + }, + { + "name": "config_group", + "type": "string" + }, + { + "name": "content_source", + "type": "string" + }, + { + "name": "content_view", + "type": "string" + }, + { + "name": "content_view_id", + "type": "integer" + }, + { + "name": "created_at", + "type": "datetime" + }, + { + "name": "domain", + "type": "string" + }, + { + "name": "domain_id", + "type": "integer" + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "errata_status", + "values": [ + "security_needed", + "errata_needed", + "updated", + "unknown" + ] + }, + { + "name": "execution_status", + "values": [ + "ok", + "error" + ] + }, + { + "name": "facts", + "type": "string" + }, + { + "name": "global_status", + "values": [ + "ok", + "warning", + "error" + ] + }, + { + "name": "has_ip", + "type": "string" + }, + { + "name": "has_mac", + "type": "string" + }, + { + "name": "host_collection", + "type": "string" + }, + { + "name": "host_collection_id", + "type": "integer" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "hostgroup_fullname", + "type": "string" + }, + { + "name": "hostgroup_id", + "type": "integer" + }, + { + "name": "hostgroup_name", + "type": "string" + }, + { + "name": "hostgroup_title", + "type": "string" + }, + { + "name": "hypervisor", + "values": [ + "true", + "false" + ] + }, + { + "name": "hypervisor_host", + "type": "string" + }, + { + "name": "image", + "type": "string" + }, + { + "name": "installable_errata", + "type": "string" + }, + { + "name": "installed_at", + "type": "datetime" + }, + { + "name": "installed_deb", + "type": "string" + }, + { + "name": "installed_package", + "type": "string" + }, + { + "name": "installed_package_name", + "type": "string" + }, + { + "name": "ip", + "type": "string" + }, + { + "name": "job_invocation.id", + "type": "string" + }, + { + "name": "job_invocation.result", + "values": [ + "cancelled", + "failed", + "pending", + "success" + ] + }, + { + "name": "last_checkin", + "type": "datetime" + }, + { + "name": "last_report", + "type": "datetime" + }, + { + "name": "lifecycle_environment", + "type": "string" + }, + { + "name": "lifecycle_environment_id", + "type": "integer" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "mac", + "type": "string" + }, + { + "name": "managed", + "values": [ + "true", + "false" + ] + }, + { + "name": "model", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "origin", + "type": "string" + }, + { + "name": "os", + "type": "string" + }, + { + "name": "os_description", + "type": "string" + }, + { + "name": "os_id", + "type": "integer" + }, + { + "name": "os_major", + "type": "string" + }, + { + "name": "os_minor", + "type": "string" + }, + { + "name": "os_title", + "type": "string" + }, + { + "name": "owner", + "type": "string" + }, + { + "name": "owner_id", + "type": "integer" + }, + { + "name": "owner_type", + "type": "string" + }, + { + "name": "params", + "type": "string" + }, + { + "name": "params_name", + "type": "string" + }, + { + "name": "parent_hostgroup", + "type": "string" + }, + { + "name": "puppet_ca", + "type": "string" + }, + { + "name": "puppet_proxy_id", + "type": "integer" + }, + { + "name": "puppetmaster", + "type": "string" + }, + { + "name": "purpose_status", + "values": [ + "mismatched", + "matched", + "not_specified" + ] + }, + { + "name": "realm", + "type": "string" + }, + { + "name": "realm_id", + "type": "integer" + }, + { + "name": "registered_at", + "type": "datetime" + }, + { + "name": "registered_through", + "type": "string" + }, + { + "name": "release_version", + "type": "string" + }, + { + "name": "role", + "type": "text" + }, + { + "name": "role_status", + "values": [ + "mismatched", + "matched", + "not_specified" + ] + }, + { + "name": "service_level", + "type": "string" + }, + { + "name": "sla_status", + "values": [ + "mismatched", + "matched", + "not_specified" + ] + }, + { + "name": "smart_proxy", + "type": "string" + }, + { + "name": "status.applied", + "type": "integer" + }, + { + "name": "status.enabled", + "values": [ + "true", + "false" + ] + }, + { + "name": "status.failed", + "type": "integer" + }, + { + "name": "status.failed_restarts", + "type": "integer" + }, + { + "name": "status.interesting", + "values": [ + "true", + "false" + ] + }, + { + "name": "status.pending", + "type": "integer" + }, + { + "name": "status.restarted", + "type": "integer" + }, + { + "name": "status.skipped", + "type": "integer" + }, + { + "name": "subnet", + "type": "string" + }, + { + "name": "subnet.name", + "type": "text" + }, + { + "name": "subnet6", + "type": "string" + }, + { + "name": "subnet6.name", + "type": "text" + }, + { + "name": "subscription_id", + "type": "string" + }, + { + "name": "subscription_name", + "type": "string" + }, + { + "name": "subscription_status", + "values": [ + "valid", + "partial", + "invalid", + "unknown", + "unsubscribed_hypervisor" + ] + }, + { + "name": "subscription_uuid", + "type": "string" + }, + { + "name": "trace_app", + "type": "string" + }, + { + "name": "trace_app_type", + "type": "string" + }, + { + "name": "trace_helper", + "type": "string" + }, + { + "name": "trace_status", + "values": [ + "reboot_needed", + "process_restart_needed", + "updated" + ] + }, + { + "name": "upgradable_debs", + "type": "string" + }, + { + "name": "upgradable_rpms", + "type": "string" + }, + { + "name": "usage", + "type": "text" + }, + { + "name": "usage_status", + "values": [ + "mismatched", + "matched", + "not_specified" + ] + }, + { + "name": "user.firstname", + "type": "string" + }, + { + "name": "user.lastname", + "type": "string" + }, + { + "name": "user.login", + "type": "string" + }, + { + "name": "user.mail", + "type": "string" + }, + { + "name": "usergroup", + "type": "string" + }, + { + "name": "usergroup.name", + "type": "string" + }, + { + "name": "uuid", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/show", + "name": "show", + "apis": [ + { + "api_url": "/api/hosts/:id", + "http_method": "GET", + "short_description": "Show a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden_parameters", + "full_name": "show_hidden_parameters", + "description": "\n

Display hidden parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hosts", + "http_method": "POST", + "short_description": "Create a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host", + "full_name": "host", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "host[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "host[location_id]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "host[organization_id]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "host[environment_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "host[ip]", + "description": "\n

not required if using a subnet with DHCP proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mac", + "full_name": "host[mac]", + "description": "\n

required for managed host that is bare metal, not required if it's a\nvirtual machine

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "host[architecture_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "host[domain_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_id", + "full_name": "host[realm_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_proxy_id", + "full_name": "host[puppet_proxy_id]", + "description": "\n

Puppet proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_ca_proxy_id", + "full_name": "host[puppet_ca_proxy_id]", + "description": "\n

Puppet CA proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_ids", + "full_name": "host[puppetclass_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_group_ids", + "full_name": "host[config_group_ids]", + "description": "\n

IDs of associated config groups

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "host[operatingsystem_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_id", + "full_name": "host[medium_id]", + "description": "\n

required if not imaged based provisioning and host is managed and value is\nnot inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pxe_loader", + "full_name": "host[pxe_loader]", + "description": "\n

DHCP filename option (Grub2/PXELinux by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_id", + "full_name": "host[ptable_id]", + "description": "\n

required if host is managed and custom partition has not been defined

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "host[subnet_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "host[compute_resource_id]", + "description": "\n

nil means host is bare metal

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "root_pass", + "full_name": "host[root_pass]", + "description": "\n

required if host is managed and value is not inherited from host group or\ndefault password in settings

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "model_id", + "full_name": "host[model_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "host[hostgroup_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "owner_id", + "full_name": "host[owner_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "owner_type", + "full_name": "host[owner_type]", + "description": "\n

Host's owner type

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: User, Usergroup.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "image_id", + "full_name": "host[image_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_parameters_attributes", + "full_name": "host[host_parameters_attributes]", + "description": "\n

Host's parameters (array or indexed hash)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "host[host_parameters_attributes][name]", + "description": "\n

Name of the parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "host[host_parameters_attributes][value]", + "description": "\n

Parameter value

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "host[host_parameters_attributes][parameter_type]", + "description": "\n

Type of value

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "host[host_parameters_attributes][hidden_value]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "build", + "full_name": "host[build]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "host[enabled]", + "description": "\n

Include this host within foreman reporting

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision_method", + "full_name": "host[provision_method]", + "description": "\n

The method used to provision the host.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: build, image, bootdisk.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "host[managed]", + "description": "\n

True/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "progress_report_id", + "full_name": "host[progress_report_id]", + "description": "\n

UUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "comment", + "full_name": "host[comment]", + "description": "\n

Additional information about this host

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "capabilities", + "full_name": "host[capabilities]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "host[compute_profile_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interfaces_attributes", + "full_name": "host[interfaces_attributes]", + "description": "\n

Host's network interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "mac", + "full_name": "host[interfaces_attributes][mac]", + "description": "\n

MAC address of interface. Required for managed interfaces on bare metal.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "host[interfaces_attributes][ip]", + "description": "\n

IPv4 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip6", + "full_name": "host[interfaces_attributes][ip6]", + "description": "\n

IPv6 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "host[interfaces_attributes][type]", + "description": "\n

Interface type, e.g. bmc. Default is interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: interface, bmc, bond, bridge.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "host[interfaces_attributes][name]", + "description": "\n

Interface's DNS name

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "host[interfaces_attributes][subnet_id]", + "description": "\n

foreman subnet ID of IPv4 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet6_id", + "full_name": "host[interfaces_attributes][subnet6_id]", + "description": "\n

foreman subnet ID of IPv6 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "host[interfaces_attributes][domain_id]", + "description": "\n

foreman domain ID of interface. Required for primary interfaces on\nmanaged hosts.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "identifier", + "full_name": "host[interfaces_attributes][identifier]", + "description": "\n

Device identifier, e.g. eth0 or eth1.1

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "host[interfaces_attributes][managed]", + "description": "\n

Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "primary", + "full_name": "host[interfaces_attributes][primary]", + "description": "\n

Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision", + "full_name": "host[interfaces_attributes][provision]", + "description": "\n

Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "host[interfaces_attributes][username]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "host[interfaces_attributes][password]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider", + "full_name": "host[interfaces_attributes][provider]", + "description": "\n

Interface provider, e.g. IPMI. Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: IPMI, SSH.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "virtual", + "full_name": "host[interfaces_attributes][virtual]", + "description": "\n

Alias or VLAN device

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tag", + "full_name": "host[interfaces_attributes][tag]", + "description": "\n

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mtu", + "full_name": "host[interfaces_attributes][mtu]", + "description": "\n

MTU, this attribute has precedence over the subnet MTU.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_to", + "full_name": "host[interfaces_attributes][attached_to]", + "description": "\n

Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mode", + "full_name": "host[interfaces_attributes][mode]", + "description": "\n

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_devices", + "full_name": "host[interfaces_attributes][attached_devices]", + "description": "\n

Identifiers of attached interfaces, e.g. `['eth1',\n'eth2']`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "bond_options", + "full_name": "host[interfaces_attributes][bond_options]", + "description": "\n

Space separated options, e.g. miimon=100. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_attributes", + "full_name": "host[interfaces_attributes][compute_attributes]", + "description": "\n

Additional compute resource specific attributes for the interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "compute_attributes", + "full_name": "host[compute_attributes]", + "description": "\n

Additional compute resource specific attributes.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_facet_attributes", + "full_name": "host[content_facet_attributes]", + "description": "\n

Parameters for host's content_facet facet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_view_id", + "full_name": "host[content_facet_attributes][content_view_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lifecycle_environment_id", + "full_name": "host[content_facet_attributes][lifecycle_environment_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_source_id", + "full_name": "host[content_facet_attributes][content_source_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "kickstart_repository_id", + "full_name": "host[content_facet_attributes][kickstart_repository_id]", + "description": "\n

Repository Id associated with the kickstart repo used for provisioning

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "subscription_facet_attributes", + "full_name": "host[subscription_facet_attributes]", + "description": "\n

Parameters for host's subscription_facet facet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "release_version", + "full_name": "host[subscription_facet_attributes][release_version]", + "description": "\n

Release version for this Host to use (7Server, 7.1, etc)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "autoheal", + "full_name": "host[subscription_facet_attributes][autoheal]", + "description": "\n

Sets whether the Host will autoheal subscriptions upon checkin

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_usage", + "full_name": "host[subscription_facet_attributes][purpose_usage]", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_role", + "full_name": "host[subscription_facet_attributes][purpose_role]", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_addons", + "full_name": "host[subscription_facet_attributes][purpose_addons]", + "description": "\n

Sets the system add-ons

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "service_level", + "full_name": "host[subscription_facet_attributes][service_level]", + "description": "\n

Service level to be used for autoheal

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_guest_uuids", + "full_name": "host[subscription_facet_attributes][hypervisor_guest_uuids]", + "description": "\n

List of hypervisor guest uuids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "installed_products_attributes", + "full_name": "host[subscription_facet_attributes][installed_products_attributes]", + "description": "\n

List of products installed on the host

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "product_id", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][product_id]", + "description": "\n

Product id as listed from a host's installed products, this is\nnot the same product id as the products api returns

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_name", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][product_name]", + "description": "\n

Product name as listed from a host's installed products

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "arch", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][arch]", + "description": "\n

Product architecture

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][version]", + "description": "\n

Product version

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ] + }, + { + "name": "ansible_role_ids", + "full_name": "host[ansible_role_ids]", + "description": "\n

IDs of associated ansible roles

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/update", + "name": "update", + "apis": [ + { + "api_url": "/api/hosts/:id", + "http_method": "PUT", + "short_description": "Update a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host", + "full_name": "host", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "host[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "host[location_id]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "host[organization_id]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "host[environment_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "host[ip]", + "description": "\n

not required if using a subnet with DHCP proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mac", + "full_name": "host[mac]", + "description": "\n

required for managed host that is bare metal, not required if it's a\nvirtual machine

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "host[architecture_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "host[domain_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_id", + "full_name": "host[realm_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_proxy_id", + "full_name": "host[puppet_proxy_id]", + "description": "\n

Puppet proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_ca_proxy_id", + "full_name": "host[puppet_ca_proxy_id]", + "description": "\n

Puppet CA proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_ids", + "full_name": "host[puppetclass_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_group_ids", + "full_name": "host[config_group_ids]", + "description": "\n

IDs of associated config groups

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "host[operatingsystem_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_id", + "full_name": "host[medium_id]", + "description": "\n

required if not imaged based provisioning and host is managed and value is\nnot inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pxe_loader", + "full_name": "host[pxe_loader]", + "description": "\n

DHCP filename option (Grub2/PXELinux by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_id", + "full_name": "host[ptable_id]", + "description": "\n

required if host is managed and custom partition has not been defined

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "host[subnet_id]", + "description": "\n

required if host is managed and value is not inherited from host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "host[compute_resource_id]", + "description": "\n

nil means host is bare metal

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "root_pass", + "full_name": "host[root_pass]", + "description": "\n

required if host is managed and value is not inherited from host group or\ndefault password in settings

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "model_id", + "full_name": "host[model_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "host[hostgroup_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "owner_id", + "full_name": "host[owner_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "owner_type", + "full_name": "host[owner_type]", + "description": "\n

Host's owner type

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: User, Usergroup.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "image_id", + "full_name": "host[image_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_parameters_attributes", + "full_name": "host[host_parameters_attributes]", + "description": "\n

Host's parameters (array or indexed hash)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "host[host_parameters_attributes][name]", + "description": "\n

Name of the parameter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "host[host_parameters_attributes][value]", + "description": "\n

Parameter value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "host[host_parameters_attributes][parameter_type]", + "description": "\n

Type of value

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "host[host_parameters_attributes][hidden_value]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "build", + "full_name": "host[build]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "host[enabled]", + "description": "\n

Include this host within foreman reporting

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision_method", + "full_name": "host[provision_method]", + "description": "\n

The method used to provision the host.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: build, image, bootdisk.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "host[managed]", + "description": "\n

True/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "progress_report_id", + "full_name": "host[progress_report_id]", + "description": "\n

UUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "comment", + "full_name": "host[comment]", + "description": "\n

Additional information about this host

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "capabilities", + "full_name": "host[capabilities]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "host[compute_profile_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interfaces_attributes", + "full_name": "host[interfaces_attributes]", + "description": "\n

Host's network interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "mac", + "full_name": "host[interfaces_attributes][mac]", + "description": "\n

MAC address of interface. Required for managed interfaces on bare metal.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "host[interfaces_attributes][ip]", + "description": "\n

IPv4 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip6", + "full_name": "host[interfaces_attributes][ip6]", + "description": "\n

IPv6 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "host[interfaces_attributes][type]", + "description": "\n

Interface type, e.g. bmc. Default is interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: interface, bmc, bond, bridge.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "host[interfaces_attributes][name]", + "description": "\n

Interface's DNS name

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "host[interfaces_attributes][subnet_id]", + "description": "\n

foreman subnet ID of IPv4 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet6_id", + "full_name": "host[interfaces_attributes][subnet6_id]", + "description": "\n

foreman subnet ID of IPv6 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "host[interfaces_attributes][domain_id]", + "description": "\n

foreman domain ID of interface. Required for primary interfaces on\nmanaged hosts.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "identifier", + "full_name": "host[interfaces_attributes][identifier]", + "description": "\n

Device identifier, e.g. eth0 or eth1.1

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "host[interfaces_attributes][managed]", + "description": "\n

Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "primary", + "full_name": "host[interfaces_attributes][primary]", + "description": "\n

Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision", + "full_name": "host[interfaces_attributes][provision]", + "description": "\n

Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "host[interfaces_attributes][username]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "host[interfaces_attributes][password]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider", + "full_name": "host[interfaces_attributes][provider]", + "description": "\n

Interface provider, e.g. IPMI. Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: IPMI, SSH.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "virtual", + "full_name": "host[interfaces_attributes][virtual]", + "description": "\n

Alias or VLAN device

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tag", + "full_name": "host[interfaces_attributes][tag]", + "description": "\n

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mtu", + "full_name": "host[interfaces_attributes][mtu]", + "description": "\n

MTU, this attribute has precedence over the subnet MTU.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_to", + "full_name": "host[interfaces_attributes][attached_to]", + "description": "\n

Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mode", + "full_name": "host[interfaces_attributes][mode]", + "description": "\n

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_devices", + "full_name": "host[interfaces_attributes][attached_devices]", + "description": "\n

Identifiers of attached interfaces, e.g. `['eth1',\n'eth2']`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "bond_options", + "full_name": "host[interfaces_attributes][bond_options]", + "description": "\n

Space separated options, e.g. miimon=100. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_attributes", + "full_name": "host[interfaces_attributes][compute_attributes]", + "description": "\n

Additional compute resource specific attributes for the interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "compute_attributes", + "full_name": "host[compute_attributes]", + "description": "\n

Additional compute resource specific attributes.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_facet_attributes", + "full_name": "host[content_facet_attributes]", + "description": "\n

Parameters for host's content_facet facet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_view_id", + "full_name": "host[content_facet_attributes][content_view_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lifecycle_environment_id", + "full_name": "host[content_facet_attributes][lifecycle_environment_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_source_id", + "full_name": "host[content_facet_attributes][content_source_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "kickstart_repository_id", + "full_name": "host[content_facet_attributes][kickstart_repository_id]", + "description": "\n

Repository Id associated with the kickstart repo used for provisioning

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "subscription_facet_attributes", + "full_name": "host[subscription_facet_attributes]", + "description": "\n

Parameters for host's subscription_facet facet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "release_version", + "full_name": "host[subscription_facet_attributes][release_version]", + "description": "\n

Release version for this Host to use (7Server, 7.1, etc)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "autoheal", + "full_name": "host[subscription_facet_attributes][autoheal]", + "description": "\n

Sets whether the Host will autoheal subscriptions upon checkin

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_usage", + "full_name": "host[subscription_facet_attributes][purpose_usage]", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_role", + "full_name": "host[subscription_facet_attributes][purpose_role]", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_addons", + "full_name": "host[subscription_facet_attributes][purpose_addons]", + "description": "\n

Sets the system add-ons

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "service_level", + "full_name": "host[subscription_facet_attributes][service_level]", + "description": "\n

Service level to be used for autoheal

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_guest_uuids", + "full_name": "host[subscription_facet_attributes][hypervisor_guest_uuids]", + "description": "\n

List of hypervisor guest uuids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "installed_products_attributes", + "full_name": "host[subscription_facet_attributes][installed_products_attributes]", + "description": "\n

List of products installed on the host

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "product_id", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][product_id]", + "description": "\n

Product id as listed from a host's installed products, this is\nnot the same product id as the products api returns

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_name", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][product_name]", + "description": "\n

Product name as listed from a host's installed products

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "arch", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][arch]", + "description": "\n

Product architecture

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "host[subscription_facet_attributes][installed_products_attributes][version]", + "description": "\n

Product version

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ] + }, + { + "name": "ansible_role_ids", + "full_name": "host[ansible_role_ids]", + "description": "\n

IDs of associated ansible roles

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hosts/:id", + "http_method": "DELETE", + "short_description": "Delete a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/enc", + "name": "enc", + "apis": [ + { + "api_url": "/api/hosts/:id/enc", + "http_method": "GET", + "short_description": "Get ENC values of host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/status", + "name": "status", + "apis": [ + { + "api_url": "/api/hosts/:id/status", + "http_method": "GET", + "short_description": "Get configuration status of host", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Return value may either be one of the following:

\n
  • \n

    Alerts disabled

    \n
  • \n

    No reports

    \n
  • \n

    Error

    \n
  • \n

    Out of sync

    \n
  • \n

    Active

    \n
  • \n

    Pending

    \n
  • \n

    No changes

    \n
\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/get_status", + "name": "get_status", + "apis": [ + { + "api_url": "/api/hosts/:id/status/:type", + "http_method": "GET", + "short_description": "Get status of host", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Returns string representing a host status of a given type

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "type", + "description": "\n

status type, can be one of

\n
  • \n

    global

    \n
  • \n

    configuration

    \n
  • \n

    build

    \n
\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: HostStatus::Global, configuration, build.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/vm_compute_attributes", + "name": "vm_compute_attributes", + "apis": [ + { + "api_url": "/api/hosts/:id/vm_compute_attributes", + "http_method": "GET", + "short_description": "Get vm attributes of host", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Return the host's compute attributes that can be used to create a clone\nof this VM

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/disassociate", + "name": "disassociate", + "apis": [ + { + "api_url": "/api/hosts/:id/disassociate", + "http_method": "PUT", + "short_description": "Disassociate the host from a VM", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/power", + "name": "power", + "apis": [ + { + "api_url": "/api/hosts/:id/power", + "http_method": "PUT", + "short_description": "Run a power operation on host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "power_action", + "full_name": "power_action", + "description": "\n

power action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/power_status", + "name": "power_status", + "apis": [ + { + "api_url": "/api/hosts/:id/power", + "http_method": "GET", + "short_description": "Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/boot", + "name": "boot", + "apis": [ + { + "api_url": "/api/hosts/:id/boot", + "http_method": "PUT", + "short_description": "Boot host from specified device", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "device", + "full_name": "device", + "description": "\n

boot device, valid devices are disk, cdrom, pxe, bios

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/facts", + "name": "facts", + "apis": [ + { + "api_url": "/api/hosts/facts", + "http_method": "POST", + "short_description": "Upload facts for a host, creating the host if required", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

hostname of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "facts", + "full_name": "facts", + "description": "\n

hash containing the facts for the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "certname", + "full_name": "certname", + "description": "\n

optional: certname of the host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "type", + "description": "\n

optional: the STI type of host to create

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/rebuild_config", + "name": "rebuild_config", + "apis": [ + { + "api_url": "/api/hosts/:id/rebuild_config", + "http_method": "PUT", + "short_description": "Rebuild orchestration config", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "only", + "full_name": "only", + "description": "\n

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/template", + "name": "template", + "apis": [ + { + "api_url": "/api/hosts/:id/template/:kind", + "http_method": "GET", + "short_description": "Preview rendered provisioning template content", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "kind", + "full_name": "kind", + "description": "\n

Template kinds, available values: Bootdisk, PXELinux, PXEGrub, PXEGrub2,\niPXE, provision, finish, script, user_data, ZTP, POAP, kexec, cloud-init

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/host_collections", + "name": "host_collections", + "apis": [ + { + "api_url": "/api/hosts/:host_id/host_collections", + "http_method": "PUT", + "short_description": "Alter a hosts host collections", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

The id of the host to alter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_collection_ids", + "full_name": "host_collection_ids", + "description": "\n

List of host collection ids to update

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/play_roles", + "name": "play_roles", + "apis": [ + { + "api_url": "/api/hosts/:id/play_roles", + "http_method": "POST", + "short_description": "Runs all Ansible roles on a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/multiple_play_roles", + "name": "multiple_play_roles", + "apis": [ + { + "api_url": "/api/hosts/multiple_play_roles", + "http_method": "POST", + "short_description": "Runs all Ansible roles on hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

IDs of hosts to play roles on

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/ansible_roles", + "name": "ansible_roles", + "apis": [ + { + "api_url": "/api/hosts/:id/ansible_roles", + "http_method": "GET", + "short_description": "List all Ansible roles for a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts/assign_ansible_roles", + "name": "assign_ansible_roles", + "apis": [ + { + "api_url": "/api/hosts/:id/assign_ansible_roles", + "http_method": "POST", + "short_description": "Assigns Ansible roles to a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_role_ids", + "full_name": "ansible_role_ids", + "description": "\n

Ansible roles to assign to a host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "interfaces": { + "doc_url": "../apidoc/v2/interfaces", + "api_url": "/api", + "name": "Interfaces", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/interfaces/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/interfaces", + "http_method": "GET", + "short_description": "List all interfaces for host", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/interfaces", + "http_method": "GET", + "short_description": "List all interfaces for domain", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/interfaces", + "http_method": "GET", + "short_description": "List all interfaces for subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID or name of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID or name of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID or name of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/interfaces/show", + "name": "show", + "apis": [ + { + "api_url": "/api/hosts/:host_id/interfaces/:id", + "http_method": "GET", + "short_description": "Show an interface for host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID or name of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID or name of interface

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/interfaces/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hosts/:host_id/interfaces", + "http_method": "POST", + "short_description": "Create an interface on a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID or name of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interface", + "full_name": "interface", + "description": "\n

interface information

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "mac", + "full_name": "interface[mac]", + "description": "\n

MAC address of interface. Required for managed interfaces on bare metal.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "interface[ip]", + "description": "\n

IPv4 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip6", + "full_name": "interface[ip6]", + "description": "\n

IPv6 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "interface[type]", + "description": "\n

Interface type, e.g. bmc. Default is interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: interface, bmc, bond, bridge.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "interface[name]", + "description": "\n

Interface's DNS name

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "interface[subnet_id]", + "description": "\n

foreman subnet ID of IPv4 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet6_id", + "full_name": "interface[subnet6_id]", + "description": "\n

foreman subnet ID of IPv6 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "interface[domain_id]", + "description": "\n

foreman domain ID of interface. Required for primary interfaces on\nmanaged hosts.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "identifier", + "full_name": "interface[identifier]", + "description": "\n

Device identifier, e.g. eth0 or eth1.1

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "interface[managed]", + "description": "\n

Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "primary", + "full_name": "interface[primary]", + "description": "\n

Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision", + "full_name": "interface[provision]", + "description": "\n

Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "interface[username]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "interface[password]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider", + "full_name": "interface[provider]", + "description": "\n

Interface provider, e.g. IPMI. Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: IPMI, SSH.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "virtual", + "full_name": "interface[virtual]", + "description": "\n

Alias or VLAN device

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tag", + "full_name": "interface[tag]", + "description": "\n

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mtu", + "full_name": "interface[mtu]", + "description": "\n

MTU, this attribute has precedence over the subnet MTU.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_to", + "full_name": "interface[attached_to]", + "description": "\n

Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mode", + "full_name": "interface[mode]", + "description": "\n

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_devices", + "full_name": "interface[attached_devices]", + "description": "\n

Identifiers of attached interfaces, e.g. `['eth1',\n'eth2']`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "bond_options", + "full_name": "interface[bond_options]", + "description": "\n

Space separated options, e.g. miimon=100. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_attributes", + "full_name": "interface[compute_attributes]", + "description": "\n

Additional compute resource specific attributes for the interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/interfaces/update", + "name": "update", + "apis": [ + { + "api_url": "/api/hosts/:host_id/interfaces/:id", + "http_method": "PUT", + "short_description": "Update a host's interface", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID or name of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of interface

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interface", + "full_name": "interface", + "description": "\n

interface information

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "mac", + "full_name": "interface[mac]", + "description": "\n

MAC address of interface. Required for managed interfaces on bare metal.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "interface[ip]", + "description": "\n

IPv4 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip6", + "full_name": "interface[ip6]", + "description": "\n

IPv6 address of interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "interface[type]", + "description": "\n

Interface type, e.g. bmc. Default is interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: interface, bmc, bond, bridge.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "interface[name]", + "description": "\n

Interface's DNS name

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "interface[subnet_id]", + "description": "\n

foreman subnet ID of IPv4 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet6_id", + "full_name": "interface[subnet6_id]", + "description": "\n

foreman subnet ID of IPv6 interface

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "interface[domain_id]", + "description": "\n

foreman domain ID of interface. Required for primary interfaces on\nmanaged hosts.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "identifier", + "full_name": "interface[identifier]", + "description": "\n

Device identifier, e.g. eth0 or eth1.1

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "interface[managed]", + "description": "\n

Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "primary", + "full_name": "interface[primary]", + "description": "\n

Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision", + "full_name": "interface[provision]", + "description": "\n

Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "interface[username]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "interface[password]", + "description": "\n

Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider", + "full_name": "interface[provider]", + "description": "\n

Interface provider, e.g. IPMI. Only for BMC interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: IPMI, SSH.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "virtual", + "full_name": "interface[virtual]", + "description": "\n

Alias or VLAN device

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tag", + "full_name": "interface[tag]", + "description": "\n

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mtu", + "full_name": "interface[mtu]", + "description": "\n

MTU, this attribute has precedence over the subnet MTU.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_to", + "full_name": "interface[attached_to]", + "description": "\n

Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mode", + "full_name": "interface[mode]", + "description": "\n

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attached_devices", + "full_name": "interface[attached_devices]", + "description": "\n

Identifiers of attached interfaces, e.g. `['eth1',\n'eth2']`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "bond_options", + "full_name": "interface[bond_options]", + "description": "\n

Space separated options, e.g. miimon=100. Only for bond interfaces.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_attributes", + "full_name": "interface[compute_attributes]", + "description": "\n

Additional compute resource specific attributes for the interface.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/interfaces/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hosts/:host_id/interfaces/:id", + "http_method": "DELETE", + "short_description": "Delete a host's interface", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID or name of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of interface

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "hostgroups": { + "doc_url": "../apidoc/v2/hostgroups", + "api_url": "/api", + "name": "Hostgroups", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/hostgroups/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hostgroups", + "http_method": "GET", + "short_description": "List all host groups", + "deprecated": null + }, + { + "api_url": "/api/puppetclasses/:puppetclass_id/hostgroups", + "http_method": "GET", + "short_description": "List all host groups for a Puppet class", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/hostgroups", + "http_method": "GET", + "short_description": "List all host groups per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/hostgroups", + "http_method": "GET", + "short_description": "List all host groups per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "puppetclass_id", + "full_name": "puppetclass_id", + "description": "\n

ID of Puppet class

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include", + "full_name": "include", + "description": "\n

Array of extra information types to include

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of [\"parameters\"]", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "architecture", + "type": "string" + }, + { + "name": "class", + "type": "string" + }, + { + "name": "config_group", + "type": "string" + }, + { + "name": "content_source", + "type": "string" + }, + { + "name": "content_view", + "type": "string" + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "host", + "type": "string" + }, + { + "name": "id", + "type": "integer" + }, + { + "name": "label", + "type": "string" + }, + { + "name": "lifecycle_environment", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "medium", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "os", + "type": "string" + }, + { + "name": "os_description", + "type": "string" + }, + { + "name": "os_id", + "type": "integer" + }, + { + "name": "os_major", + "type": "string" + }, + { + "name": "os_minor", + "type": "string" + }, + { + "name": "os_title", + "type": "string" + }, + { + "name": "params", + "type": "text" + }, + { + "name": "template", + "type": "string" + }, + { + "name": "title", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/show", + "name": "show", + "apis": [ + { + "api_url": "/api/hostgroups/:id", + "http_method": "GET", + "short_description": "Show a host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden_parameters", + "full_name": "show_hidden_parameters", + "description": "\n

Display hidden parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hostgroups", + "http_method": "POST", + "short_description": "Create a host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup", + "full_name": "hostgroup", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "hostgroup[name]", + "description": "\n

Name of the host group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "hostgroup[description]", + "description": "\n

Host group description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parent_id", + "full_name": "hostgroup[parent_id]", + "description": "\n

Parent ID of the host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "hostgroup[environment_id]", + "description": "\n

Environment ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "hostgroup[compute_profile_id]", + "description": "\n

Compute profile ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "hostgroup[compute_resource_id]", + "description": "\n

Compute resource ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "hostgroup[operatingsystem_id]", + "description": "\n

Operating system ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "hostgroup[architecture_id]", + "description": "\n

Architecture ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pxe_loader", + "full_name": "hostgroup[pxe_loader]", + "description": "\n

DHCP filename option (Grub2/PXELinux by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_id", + "full_name": "hostgroup[medium_id]", + "description": "\n

Media ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_id", + "full_name": "hostgroup[ptable_id]", + "description": "\n

Partition table ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "hostgroup[subnet_id]", + "description": "\n

Subnet ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet6_id", + "full_name": "hostgroup[subnet6_id]", + "description": "\n

Subnet IPv6 ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "hostgroup[domain_id]", + "description": "\n

Domain ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_id", + "full_name": "hostgroup[realm_id]", + "description": "\n

Realm ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_group_ids", + "full_name": "hostgroup[config_group_ids]", + "description": "\n

IDs of associated config groups

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "group_parameters_attributes", + "full_name": "hostgroup[group_parameters_attributes]", + "description": "\n

Array of parameters

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "hostgroup[group_parameters_attributes][name]", + "description": "\n

Name of the parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "hostgroup[group_parameters_attributes][value]", + "description": "\n

Parameter value

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "hostgroup[group_parameters_attributes][parameter_type]", + "description": "\n

Type of value

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "hostgroup[group_parameters_attributes][hidden_value]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "puppet_proxy_id", + "full_name": "hostgroup[puppet_proxy_id]", + "description": "\n

Puppet proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_ca_proxy_id", + "full_name": "hostgroup[puppet_ca_proxy_id]", + "description": "\n

Puppet CA proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "root_pass", + "full_name": "hostgroup[root_pass]", + "description": "\n

Root password on provisioned hosts

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "hostgroup[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "hostgroup[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_source_id", + "full_name": "hostgroup[content_source_id]", + "description": "\n

Content source ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "hostgroup[content_view_id]", + "description": "\n

Content view ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lifecycle_environment_id", + "full_name": "hostgroup[lifecycle_environment_id]", + "description": "\n

Lifecycle environment ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "kickstart_repository_id", + "full_name": "hostgroup[kickstart_repository_id]", + "description": "\n

Kickstart repository ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_role_ids", + "full_name": "hostgroup[ansible_role_ids]", + "description": "\n

IDs of associated ansible roles

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/update", + "name": "update", + "apis": [ + { + "api_url": "/api/hostgroups/:id", + "http_method": "PUT", + "short_description": "Update a host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup", + "full_name": "hostgroup", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "hostgroup[name]", + "description": "\n

Name of the host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "hostgroup[description]", + "description": "\n

Host group description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parent_id", + "full_name": "hostgroup[parent_id]", + "description": "\n

Parent ID of the host group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "hostgroup[environment_id]", + "description": "\n

Environment ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "hostgroup[compute_profile_id]", + "description": "\n

Compute profile ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "hostgroup[compute_resource_id]", + "description": "\n

Compute resource ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "hostgroup[operatingsystem_id]", + "description": "\n

Operating system ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "hostgroup[architecture_id]", + "description": "\n

Architecture ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pxe_loader", + "full_name": "hostgroup[pxe_loader]", + "description": "\n

DHCP filename option (Grub2/PXELinux by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_id", + "full_name": "hostgroup[medium_id]", + "description": "\n

Media ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_id", + "full_name": "hostgroup[ptable_id]", + "description": "\n

Partition table ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "hostgroup[subnet_id]", + "description": "\n

Subnet ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet6_id", + "full_name": "hostgroup[subnet6_id]", + "description": "\n

Subnet IPv6 ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "hostgroup[domain_id]", + "description": "\n

Domain ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_id", + "full_name": "hostgroup[realm_id]", + "description": "\n

Realm ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_group_ids", + "full_name": "hostgroup[config_group_ids]", + "description": "\n

IDs of associated config groups

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "group_parameters_attributes", + "full_name": "hostgroup[group_parameters_attributes]", + "description": "\n

Array of parameters

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "hostgroup[group_parameters_attributes][name]", + "description": "\n

Name of the parameter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "hostgroup[group_parameters_attributes][value]", + "description": "\n

Parameter value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "hostgroup[group_parameters_attributes][parameter_type]", + "description": "\n

Type of value

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "hostgroup[group_parameters_attributes][hidden_value]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "puppet_proxy_id", + "full_name": "hostgroup[puppet_proxy_id]", + "description": "\n

Puppet proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_ca_proxy_id", + "full_name": "hostgroup[puppet_ca_proxy_id]", + "description": "\n

Puppet CA proxy ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "root_pass", + "full_name": "hostgroup[root_pass]", + "description": "\n

Root password on provisioned hosts

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "hostgroup[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "hostgroup[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_source_id", + "full_name": "hostgroup[content_source_id]", + "description": "\n

Content source ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "hostgroup[content_view_id]", + "description": "\n

Content view ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lifecycle_environment_id", + "full_name": "hostgroup[lifecycle_environment_id]", + "description": "\n

Lifecycle environment ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "kickstart_repository_id", + "full_name": "hostgroup[kickstart_repository_id]", + "description": "\n

Kickstart repository ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_role_ids", + "full_name": "hostgroup[ansible_role_ids]", + "description": "\n

IDs of associated ansible roles

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hostgroups/:id", + "http_method": "DELETE", + "short_description": "Delete a host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/hostgroups/:id/clone", + "http_method": "POST", + "short_description": "Clone a host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/rebuild_config", + "name": "rebuild_config", + "apis": [ + { + "api_url": "/api/hostgroups/:id/rebuild_config", + "http_method": "PUT", + "short_description": "Rebuild orchestration config", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "only", + "full_name": "only", + "description": "\n

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "children_hosts", + "full_name": "children_hosts", + "description": "\n

Operate on child hostgroup hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/play_roles", + "name": "play_roles", + "apis": [ + { + "api_url": "/api/hostgroups/:id/play_roles", + "http_method": "POST", + "short_description": "Runs all Ansible roles on a hostgroup", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/multiple_play_roles", + "name": "multiple_play_roles", + "apis": [ + { + "api_url": "/api/hostgroups/multiple_play_roles", + "http_method": "POST", + "short_description": "Runs all Ansible roles on hostgroups", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "hostgroup_ids", + "description": "\n

IDs of hostgroups to play roles on

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/ansible_roles", + "name": "ansible_roles", + "apis": [ + { + "api_url": "/api/hostgroups/:id/ansible_roles", + "http_method": "GET", + "short_description": "List all Ansible roles for a hostgroup", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroups/assign_ansible_roles", + "name": "assign_ansible_roles", + "apis": [ + { + "api_url": "/api/hostgroups/:id/assign_ansible_roles", + "http_method": "POST", + "short_description": "Assigns Ansible roles to a hostgroup", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_role_ids", + "full_name": "ansible_role_ids", + "description": "\n

Ansible roles to assign to a hostgroup

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "smart_proxies": { + "doc_url": "../apidoc/v2/smart_proxies", + "api_url": "/api", + "name": "Smart proxies", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/smart_proxies/import_puppetclasses", + "name": "import_puppetclasses", + "apis": [ + { + "api_url": "/api/smart_proxies/:id/import_puppetclasses", + "http_method": "POST", + "short_description": "Import puppet classes from puppet proxy", + "deprecated": null + }, + { + "api_url": "/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses", + "http_method": "POST", + "short_description": "Import puppet classes from puppet proxy for an environment", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses", + "http_method": "POST", + "short_description": "Import puppet classes from puppet proxy for an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy_id", + "full_name": "smart_proxy_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dryrun", + "full_name": "dryrun", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "except", + "full_name": "except", + "description": "\n

Optional comma-delimited string containing either 'new',\n'updated', or 'obsolete' that is used to limit the imported\nPuppet classes

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_proxies/index", + "name": "index", + "apis": [ + { + "api_url": "/api/smart_proxies", + "http_method": "GET", + "short_description": "List all smart proxies", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "feature", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "url", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_proxies/show", + "name": "show", + "apis": [ + { + "api_url": "/api/smart_proxies/:id", + "http_method": "GET", + "short_description": "Show a smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_proxies/create", + "name": "create", + "apis": [ + { + "api_url": "/api/smart_proxies", + "http_method": "POST", + "short_description": "Create a smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy", + "full_name": "smart_proxy", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "smart_proxy[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "smart_proxy[url]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "smart_proxy[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "smart_proxy[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "download_policy", + "full_name": "smart_proxy[download_policy]", + "description": "\n

Download Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_proxies/update", + "name": "update", + "apis": [ + { + "api_url": "/api/smart_proxies/:id", + "http_method": "PUT", + "short_description": "Update a smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy", + "full_name": "smart_proxy", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "smart_proxy[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "smart_proxy[url]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "smart_proxy[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "smart_proxy[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "download_policy", + "full_name": "smart_proxy[download_policy]", + "description": "\n

Download Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_proxies/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/smart_proxies/:id", + "http_method": "DELETE", + "short_description": "Delete a smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_proxies/refresh", + "name": "refresh", + "apis": [ + { + "api_url": "/api/smart_proxies/:id/refresh", + "http_method": "PUT", + "short_description": "Refresh smart proxy features", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "fact_values": { + "doc_url": "../apidoc/v2/fact_values", + "api_url": "/api", + "name": "Fact values", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/fact_values/index", + "name": "index", + "apis": [ + { + "api_url": "/api/fact_values", + "http_method": "GET", + "short_description": "List all fact values", + "deprecated": null + }, + { + "api_url": "/api/hosts/:host_id/facts", + "http_method": "GET", + "short_description": "List all fact values of a given host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "fact", + "type": "string" + }, + { + "name": "fact_short_name", + "type": "string" + }, + { + "name": "facts", + "type": "string" + }, + { + "name": "host", + "type": "string" + }, + { + "name": "host.hostgroup", + "type": "string" + }, + { + "name": "host_id", + "type": "integer" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "origin", + "type": "string" + }, + { + "name": "reported_at", + "type": "datetime" + }, + { + "name": "short_name", + "type": "string" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "http_proxies": { + "doc_url": "../apidoc/v2/http_proxies", + "api_url": "/api", + "name": "Http proxies", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/http_proxies/index", + "name": "index", + "apis": [ + { + "api_url": "/api/http_proxies", + "http_method": "GET", + "short_description": "List of HTTP Proxies", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/http_proxies/show", + "name": "show", + "apis": [ + { + "api_url": "/api/http_proxies/:id", + "http_method": "GET", + "short_description": "Show an HTTP Proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Identifier of the HTTP Proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/http_proxies/create", + "name": "create", + "apis": [ + { + "api_url": "/api/http_proxies", + "http_method": "POST", + "short_description": "Create an HTTP Proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy", + "full_name": "http_proxy", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "http_proxy[name]", + "description": "\n

The HTTP Proxy name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "http_proxy[url]", + "description": "\n

URL of the HTTP Proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "http_proxy[username]", + "description": "\n

Username used to authenticate with the HTTP Proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "http_proxy[password]", + "description": "\n

Password used to authenticate with the HTTP Proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "http_proxy[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "http_proxy[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/http_proxies/update", + "name": "update", + "apis": [ + { + "api_url": "/api/http_proxies/:id", + "http_method": "PUT", + "short_description": "Update an HTTP Proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy", + "full_name": "http_proxy", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "http_proxy[name]", + "description": "\n

The HTTP Proxy name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "http_proxy[url]", + "description": "\n

URL of the HTTP Proxy

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "http_proxy[username]", + "description": "\n

Username used to authenticate with the HTTP Proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "http_proxy[password]", + "description": "\n

Password used to authenticate with the HTTP Proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "http_proxy[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "http_proxy[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/http_proxies/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/http_proxies/:id", + "http_method": "DELETE", + "short_description": "Delete an HTTP Proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "architectures": { + "doc_url": "../apidoc/v2/architectures", + "api_url": "/api", + "name": "Architectures", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/architectures/index", + "name": "index", + "apis": [ + { + "api_url": "/api/architectures", + "http_method": "GET", + "short_description": "List all architectures", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/architectures", + "http_method": "GET", + "short_description": "List all architectures for operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/architectures/show", + "name": "show", + "apis": [ + { + "api_url": "/api/architectures/:id", + "http_method": "GET", + "short_description": "Show an architecture", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/architectures/create", + "name": "create", + "apis": [ + { + "api_url": "/api/architectures", + "http_method": "POST", + "short_description": "Create an architecture", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture", + "full_name": "architecture", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "architecture[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "architecture[operatingsystem_ids]", + "description": "\n

Operating system IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/architectures/update", + "name": "update", + "apis": [ + { + "api_url": "/api/architectures/:id", + "http_method": "PUT", + "short_description": "Update an architecture", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture", + "full_name": "architecture", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "architecture[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "architecture[operatingsystem_ids]", + "description": "\n

Operating system IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/architectures/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/architectures/:id", + "http_method": "DELETE", + "short_description": "Delete an architecture", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "personal_access_tokens": { + "doc_url": "../apidoc/v2/personal_access_tokens", + "api_url": "/api", + "name": "Personal access tokens", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/personal_access_tokens/index", + "name": "index", + "apis": [ + { + "api_url": "/api/users/:user_id/personal_access_tokens", + "http_method": "GET", + "short_description": "List all Personal Access Tokens for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/personal_access_tokens/show", + "name": "show", + "apis": [ + { + "api_url": "/api/users/:user_id/personal_access_tokens/:id", + "http_method": "GET", + "short_description": "Show a Personal Access Token for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/personal_access_tokens/create", + "name": "create", + "apis": [ + { + "api_url": "/api/users/:user_id/personal_access_tokens", + "http_method": "POST", + "short_description": "Create a Personal Access Token for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "personal_access_token", + "full_name": "personal_access_token", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "personal_access_token[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "expires_at", + "full_name": "personal_access_token[expires_at]", + "description": "\n

Expiry Date

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "DateTime", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/personal_access_tokens/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/users/:user_id/personal_access_tokens/:id", + "http_method": "DELETE", + "short_description": "Revoke a Personal Access Token for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "audits": { + "doc_url": "../apidoc/v2/audits", + "api_url": "/api", + "name": "Audits", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/audits/index", + "name": "index", + "apis": [ + { + "api_url": "/api/audits", + "http_method": "GET", + "short_description": "List all audits", + "deprecated": null + }, + { + "api_url": "/api/hosts/:host_id/audits", + "http_method": "GET", + "short_description": "List all audits for a given host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "action", + "values": [ + "create", + "update", + "delete" + ] + }, + { + "name": "auditable_id", + "type": "integer" + }, + { + "name": "changes", + "type": "text" + }, + { + "name": "comment", + "type": "string" + }, + { + "name": "host", + "type": "string" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "hostgroup_title", + "type": "string" + }, + { + "name": "id", + "type": "integer" + }, + { + "name": "interface_fqdn", + "type": "string" + }, + { + "name": "interface_ip", + "type": "string" + }, + { + "name": "interface_mac", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "os", + "type": "string" + }, + { + "name": "os_title", + "type": "string" + }, + { + "name": "parameter", + "type": "string" + }, + { + "name": "partition_table", + "type": "string" + }, + { + "name": "provisioning_template", + "type": "string" + }, + { + "name": "puppetclass", + "type": "string" + }, + { + "name": "remote_address", + "type": "string" + }, + { + "name": "setting", + "type": "string" + }, + { + "name": "time", + "type": "datetime" + }, + { + "name": "type", + "values": [ + "role", + "ptable", + "provisioning_template", + "user", + "filter", + "subnet", + "hostgroup", + "smart_proxy", + "katello/host/content_facet", + "katello/host/subscription_facet", + "remote_execution_feature", + "usergroup", + "katello/content_view", + "katello/kt_environment", + "architecture", + "bookmark", + "compute_profile", + "domain", + "environment", + "image", + "medium", + "model", + "puppetclass", + "realm", + "config_group", + "discovery_rule", + "katello/activation_key", + "katello/gpg_key", + "katello/host_collection", + "katello/product", + "katello/sync_plan", + "job_template", + "job_invocation", + "key_pair", + "ssh_key", + "http_proxy", + "personal_access_token", + "ansible_role", + "report_template", + "foreman_virt_who_configure/config", + "lookup_value", + "hostgroup_class", + "auth_source", + "compute_resource", + "host", + "interface", + "location", + "organization", + "os", + "override_value", + "parameter", + "partition_table", + "setting", + "smart_class_parameter", + "smart_variable" + ] + }, + { + "name": "user", + "type": "string" + }, + { + "name": "username", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/audits/show", + "name": "show", + "apis": [ + { + "api_url": "/api/audits/:id", + "http_method": "GET", + "short_description": "Show an audit", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "realms": { + "doc_url": "../apidoc/v2/realms", + "api_url": "/api", + "name": "Realms", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/realms/index", + "name": "index", + "apis": [ + { + "api_url": "/api/realms", + "http_method": "GET", + "short_description": "List of realms", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "type", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/realms/show", + "name": "show", + "apis": [ + { + "api_url": "/api/realms/:id", + "http_method": "GET", + "short_description": "Show a realm", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Numerical ID or realm name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/realms/create", + "name": "create", + "apis": [ + { + "api_url": "/api/realms", + "http_method": "POST", + "short_description": "Create a realm", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

The name field is used for the name of the realm.

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm", + "full_name": "realm", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "realm[name]", + "description": "\n

The realm name, e.g. EXAMPLE.COM

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_proxy_id", + "full_name": "realm[realm_proxy_id]", + "description": "\n

Proxy ID to use within this realm

\n", + "required": true, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_type", + "full_name": "realm[realm_type]", + "description": "\n

Realm type, e.g. FreeIPA or Active Directory

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "realm[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "realm[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/realms/update", + "name": "update", + "apis": [ + { + "api_url": "/api/realms/:id", + "http_method": "PUT", + "short_description": "Update a realm", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm", + "full_name": "realm", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "realm[name]", + "description": "\n

The realm name, e.g. EXAMPLE.COM

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_proxy_id", + "full_name": "realm[realm_proxy_id]", + "description": "\n

Proxy ID to use within this realm

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_type", + "full_name": "realm[realm_type]", + "description": "\n

Realm type, e.g. FreeIPA or Active Directory

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "realm[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "realm[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/realms/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/realms/:id", + "http_method": "DELETE", + "short_description": "Delete a realm", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "auth_source_ldaps": { + "doc_url": "../apidoc/v2/auth_source_ldaps", + "api_url": "/api", + "name": "Auth source ldaps", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/auth_source_ldaps/index", + "name": "index", + "apis": [ + { + "api_url": "/api/auth_source_ldaps", + "http_method": "GET", + "short_description": "List all LDAP authentication sources", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/auth_source_ldaps", + "http_method": "GET", + "short_description": "List LDAP authentication sources per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/auth_source_ldaps", + "http_method": "GET", + "short_description": "List LDAP authentication sources per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_ldaps/show", + "name": "show", + "apis": [ + { + "api_url": "/api/auth_source_ldaps/:id", + "http_method": "GET", + "short_description": "Show an LDAP authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_ldaps/create", + "name": "create", + "apis": [ + { + "api_url": "/api/auth_source_ldaps", + "http_method": "POST", + "short_description": "Create an LDAP authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_ldap", + "full_name": "auth_source_ldap", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "auth_source_ldap[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host", + "full_name": "auth_source_ldap[host]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "port", + "full_name": "auth_source_ldap[port]", + "description": "\n

defaults to 389

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "account", + "full_name": "auth_source_ldap[account]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "base_dn", + "full_name": "auth_source_ldap[base_dn]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "account_password", + "full_name": "auth_source_ldap[account_password]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_login", + "full_name": "auth_source_ldap[attr_login]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_firstname", + "full_name": "auth_source_ldap[attr_firstname]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_lastname", + "full_name": "auth_source_ldap[attr_lastname]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_mail", + "full_name": "auth_source_ldap[attr_mail]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_photo", + "full_name": "auth_source_ldap[attr_photo]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "onthefly_register", + "full_name": "auth_source_ldap[onthefly_register]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_sync", + "full_name": "auth_source_ldap[usergroup_sync]", + "description": "\n

sync external user groups on login

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tls", + "full_name": "auth_source_ldap[tls]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "groups_base", + "full_name": "auth_source_ldap[groups_base]", + "description": "\n

groups base DN

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_netgroups", + "full_name": "auth_source_ldap[use_netgroups]", + "description": "\n

use NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "server_type", + "full_name": "auth_source_ldap[server_type]", + "description": "\n

type of the LDAP server

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: free_ipa, active_directory, posix.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ldap_filter", + "full_name": "auth_source_ldap[ldap_filter]", + "description": "\n

LDAP filter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "auth_source_ldap[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "auth_source_ldap[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_ldaps/update", + "name": "update", + "apis": [ + { + "api_url": "/api/auth_source_ldaps/:id", + "http_method": "PUT", + "short_description": "Update an LDAP authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_ldap", + "full_name": "auth_source_ldap", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "auth_source_ldap[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host", + "full_name": "auth_source_ldap[host]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "port", + "full_name": "auth_source_ldap[port]", + "description": "\n

defaults to 389

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "account", + "full_name": "auth_source_ldap[account]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "base_dn", + "full_name": "auth_source_ldap[base_dn]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "account_password", + "full_name": "auth_source_ldap[account_password]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_login", + "full_name": "auth_source_ldap[attr_login]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_firstname", + "full_name": "auth_source_ldap[attr_firstname]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_lastname", + "full_name": "auth_source_ldap[attr_lastname]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_mail", + "full_name": "auth_source_ldap[attr_mail]", + "description": "\n

required if onthefly_register is true

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attr_photo", + "full_name": "auth_source_ldap[attr_photo]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "onthefly_register", + "full_name": "auth_source_ldap[onthefly_register]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_sync", + "full_name": "auth_source_ldap[usergroup_sync]", + "description": "\n

sync external user groups on login

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tls", + "full_name": "auth_source_ldap[tls]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "groups_base", + "full_name": "auth_source_ldap[groups_base]", + "description": "\n

groups base DN

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_netgroups", + "full_name": "auth_source_ldap[use_netgroups]", + "description": "\n

use NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "server_type", + "full_name": "auth_source_ldap[server_type]", + "description": "\n

type of the LDAP server

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: free_ipa, active_directory, posix.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ldap_filter", + "full_name": "auth_source_ldap[ldap_filter]", + "description": "\n

LDAP filter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "auth_source_ldap[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "auth_source_ldap[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_ldaps/test", + "name": "test", + "apis": [ + { + "api_url": "/api/auth_source_ldaps/:id/test", + "http_method": "PUT", + "short_description": "Test LDAP connection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_ldaps/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/auth_source_ldaps/:id", + "http_method": "DELETE", + "short_description": "Delete an LDAP authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "puppet_hosts": { + "doc_url": "../apidoc/v2/puppet_hosts", + "api_url": "/api", + "name": "Puppet hosts", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/puppet_hosts/puppetrun", + "name": "puppetrun", + "apis": [ + { + "api_url": "/api/hosts/:id/puppetrun", + "http_method": "PUT", + "short_description": "Force a Puppet agent run on the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "autosign": { + "doc_url": "../apidoc/v2/autosign", + "api_url": "/api", + "name": "Autosign", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/autosign/index", + "name": "index", + "apis": [ + { + "api_url": "/api/smart_proxies/:smart_proxy_id/autosign", + "http_method": "GET", + "short_description": "List all autosign entries", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/autosign/create", + "name": "create", + "apis": [ + { + "api_url": "/api/smart_proxies/:smart_proxy_id/autosign", + "http_method": "POST", + "short_description": "Create autosign entry", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Autosign entry name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/autosign/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/smart_proxies/:smart_proxy_id/autosign/:id", + "http_method": "DELETE", + "short_description": "Delete autosign entry", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Autosign entry name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "table_preferences": { + "doc_url": "../apidoc/v2/table_preferences", + "api_url": "/api", + "name": "Table preferences", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/table_preferences/index", + "name": "index", + "apis": [ + { + "api_url": "/api/users/:user_id/table_preferences", + "http_method": "GET", + "short_description": "List of table preferences for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/table_preferences/show", + "name": "show", + "apis": [ + { + "api_url": "/api/users/:user_id/table_preferences/:name", + "http_method": "GET", + "short_description": "Table preference details of a given table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/table_preferences/create", + "name": "create", + "apis": [ + { + "api_url": "/api/users/:user_id/table_preferences", + "http_method": "POST", + "short_description": "Creates a table preference for a given table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "table_preferences", + "full_name": "table_preferences", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "table_preferences[name]", + "description": "\n

Name of the table

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "columns", + "full_name": "table_preferences[columns]", + "description": "\n

List of user selected columns

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/table_preferences/update", + "name": "update", + "apis": [ + { + "api_url": "/api/users/:user_id/table_preferences/:name", + "http_method": "PUT", + "short_description": "Updates a table preference for a given table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "table_preferences", + "full_name": "table_preferences", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "table_preferences[name]", + "description": "\n

Name of the table

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "columns", + "full_name": "table_preferences[columns]", + "description": "\n

List of user selected columns

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/table_preferences/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/users/:user_id/table_preferences/:name", + "http_method": "DELETE", + "short_description": "Delete a table preference for a given table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the table

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "bookmarks": { + "doc_url": "../apidoc/v2/bookmarks", + "api_url": "/api", + "name": "Bookmarks", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/bookmarks/index", + "name": "index", + "apis": [ + { + "api_url": "/api/bookmarks", + "http_method": "GET", + "short_description": "List all bookmarks", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "controller", + "type": "string" + }, + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/bookmarks/show", + "name": "show", + "apis": [ + { + "api_url": "/api/bookmarks/:id", + "http_method": "GET", + "short_description": "Show a bookmark", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/bookmarks/create", + "name": "create", + "apis": [ + { + "api_url": "/api/bookmarks", + "http_method": "POST", + "short_description": "Create a bookmark", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "bookmark", + "full_name": "bookmark", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "bookmark[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "controller", + "full_name": "bookmark[controller]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "query", + "full_name": "bookmark[query]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "public", + "full_name": "bookmark[public]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/bookmarks/update", + "name": "update", + "apis": [ + { + "api_url": "/api/bookmarks/:id", + "http_method": "PUT", + "short_description": "Update a bookmark", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "bookmark", + "full_name": "bookmark", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "bookmark[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "controller", + "full_name": "bookmark[controller]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "query", + "full_name": "bookmark[query]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "public", + "full_name": "bookmark[public]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/bookmarks/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/bookmarks/:id", + "http_method": "DELETE", + "short_description": "Delete a bookmark", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "reports": { + "doc_url": "../apidoc/v2/reports", + "api_url": "/api", + "name": "Reports", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/reports/index", + "name": "index", + "apis": [ + { + "api_url": "/api/reports", + "http_method": "GET", + "short_description": "List all reports", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/reports/show", + "name": "show", + "apis": [ + { + "api_url": "/api/reports/:id", + "http_method": "GET", + "short_description": "Show a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/reports/create", + "name": "create", + "apis": [ + { + "api_url": "/api/reports", + "http_method": "POST", + "short_description": "Create a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report", + "full_name": "report", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "host", + "full_name": "report[host]", + "description": "\n

Hostname or certname

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "reported_at", + "full_name": "report[reported_at]", + "description": "\n

UTC time of report

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "status", + "full_name": "report[status]", + "description": "\n

Hash of status type totals

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "metrics", + "full_name": "report[metrics]", + "description": "\n

Hash of report metrics, can be just {}

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "logs", + "full_name": "report[logs]", + "description": "\n

Optional array of log hashes

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/reports/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/reports/:id", + "http_method": "DELETE", + "short_description": "Delete a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/reports/last", + "name": "last", + "apis": [ + { + "api_url": "/api/hosts/:host_id/reports/last", + "http_method": "GET", + "short_description": "Show the last report for a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "common_parameters": { + "doc_url": "../apidoc/v2/common_parameters", + "api_url": "/api", + "name": "Common parameters", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/common_parameters/index", + "name": "index", + "apis": [ + { + "api_url": "/api/common_parameters", + "http_method": "GET", + "short_description": "List all global parameters", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "domain_name", + "type": "string" + }, + { + "name": "host_group_name", + "type": "string" + }, + { + "name": "host_name", + "type": "string" + }, + { + "name": "key_type", + "type": "string" + }, + { + "name": "location_name", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_name", + "type": "string" + }, + { + "name": "os_name", + "type": "string" + }, + { + "name": "parameter_type", + "type": "string" + }, + { + "name": "subnet_name", + "type": "text" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "value", + "type": "text" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/common_parameters/show", + "name": "show", + "apis": [ + { + "api_url": "/api/common_parameters/:id", + "http_method": "GET", + "short_description": "Show a global parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/common_parameters/create", + "name": "create", + "apis": [ + { + "api_url": "/api/common_parameters", + "http_method": "POST", + "short_description": "Create a global parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "common_parameter", + "full_name": "common_parameter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "common_parameter[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "common_parameter[value]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "common_parameter[parameter_type]", + "description": "\n

Type of value

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "common_parameter[hidden_value]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/common_parameters/update", + "name": "update", + "apis": [ + { + "api_url": "/api/common_parameters/:id", + "http_method": "PUT", + "short_description": "Update a global parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "common_parameter", + "full_name": "common_parameter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "common_parameter[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "common_parameter[value]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "common_parameter[parameter_type]", + "description": "\n

Type of value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "common_parameter[hidden_value]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/common_parameters/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/common_parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a global parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "roles": { + "doc_url": "../apidoc/v2/roles", + "api_url": "/api", + "name": "Roles", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/roles/index", + "name": "index", + "apis": [ + { + "api_url": "/api/roles", + "http_method": "GET", + "short_description": "List all roles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "builtin", + "values": [ + "true", + "false" + ] + }, + { + "name": "description", + "type": "text" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "permission", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/roles/show", + "name": "show", + "apis": [ + { + "api_url": "/api/roles/:id", + "http_method": "GET", + "short_description": "Show a role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/roles/create", + "name": "create", + "apis": [ + { + "api_url": "/api/roles", + "http_method": "POST", + "short_description": "Create a role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role", + "full_name": "role", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "role[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "role[description]", + "description": "\n

Role description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "role[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "role[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/roles/update", + "name": "update", + "apis": [ + { + "api_url": "/api/roles/:id", + "http_method": "PUT", + "short_description": "Update a role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role", + "full_name": "role", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "role[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "role[description]", + "description": "\n

Role description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "role[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "role[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/roles/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/roles/:id", + "http_method": "DELETE", + "short_description": "Delete a role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/roles/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/roles/:id/clone", + "http_method": "POST", + "short_description": "Clone a role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role", + "full_name": "role", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "role[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "role[description]", + "description": "\n

Role description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "role[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "role[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "compute_attributes": { + "doc_url": "../apidoc/v2/compute_attributes", + "api_url": "/api", + "name": "Compute attributes", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/compute_attributes/index", + "name": "index", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes", + "http_method": "GET", + "short_description": "List of compute attributes for provided compute profile and compute resource", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes", + "http_method": "GET", + "short_description": "List of compute attributes for provided compute profile and compute resource", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_attributes", + "http_method": "GET", + "short_description": "List of compute attributes for compute resource", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_attributes", + "http_method": "GET", + "short_description": "List of compute attributes for compute profile", + "deprecated": null + }, + { + "api_url": "/api/compute_attributes/:id", + "http_method": "GET", + "short_description": "List of compute attributes", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "compute_profile_id", + "description": "\n

ID of compute profile

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "\n

ID of compute_resource

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "compute_profile", + "type": "string" + }, + { + "name": "compute_resource", + "type": "string" + }, + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_attributes/show", + "name": "show", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id", + "http_method": "GET", + "short_description": "Show a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id", + "http_method": "GET", + "short_description": "Show a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_attributes/:id", + "http_method": "GET", + "short_description": "Show a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_attributes/:id", + "http_method": "GET", + "short_description": "Show a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_attributes/:id", + "http_method": "GET", + "short_description": "Show a compute attributes set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_attributes/create", + "name": "create", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes", + "http_method": "POST", + "short_description": "Create a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes", + "http_method": "POST", + "short_description": "Create a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_attributes", + "http_method": "POST", + "short_description": "Create a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_attributes", + "http_method": "POST", + "short_description": "Create a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_attributes", + "http_method": "POST", + "short_description": "Create a compute attributes set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "compute_profile_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_attribute", + "full_name": "compute_attribute", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "vm_attrs", + "full_name": "compute_attribute[vm_attrs]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_attributes/update", + "name": "update", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id", + "http_method": "PUT", + "short_description": "Update a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id", + "http_method": "PUT", + "short_description": "Update a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:compute_resource_id/compute_attributes/:id", + "http_method": "PUT", + "short_description": "Update a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_profiles/:compute_profile_id/compute_attributes/:id", + "http_method": "PUT", + "short_description": "Update a compute attributes set", + "deprecated": null + }, + { + "api_url": "/api/compute_attributes/:id", + "http_method": "PUT", + "short_description": "Update a compute attributes set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile_id", + "full_name": "compute_profile_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_attribute", + "full_name": "compute_attribute", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "vm_attrs", + "full_name": "compute_attribute[vm_attrs]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "statistics": { + "doc_url": "../apidoc/v2/statistics", + "api_url": "/api", + "name": "Statistics", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/statistics/index", + "name": "index", + "apis": [ + { + "api_url": "/api/statistics", + "http_method": "GET", + "short_description": "Get statistics", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "compute_profiles": { + "doc_url": "../apidoc/v2/compute_profiles", + "api_url": "/api", + "name": "Compute profiles", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/compute_profiles/index", + "name": "index", + "apis": [ + { + "api_url": "/api/compute_profiles", + "http_method": "GET", + "short_description": "List of compute profiles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_profiles/show", + "name": "show", + "apis": [ + { + "api_url": "/api/compute_profiles/:id", + "http_method": "GET", + "short_description": "Show a compute profile", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_profiles/create", + "name": "create", + "apis": [ + { + "api_url": "/api/compute_profiles", + "http_method": "POST", + "short_description": "Create a compute profile", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile", + "full_name": "compute_profile", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "compute_profile[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_profiles/update", + "name": "update", + "apis": [ + { + "api_url": "/api/compute_profiles/:id", + "http_method": "PUT", + "short_description": "Update a compute profile", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_profile", + "full_name": "compute_profile", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "compute_profile[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_profiles/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/compute_profiles/:id", + "http_method": "DELETE", + "short_description": "Delete a compute profile", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "settings": { + "doc_url": "../apidoc/v2/settings", + "api_url": "/api", + "name": "Settings", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/settings/index", + "name": "index", + "apis": [ + { + "api_url": "/api/settings", + "http_method": "GET", + "short_description": "List all settings", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "description", + "type": "text" + }, + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/settings/show", + "name": "show", + "apis": [ + { + "api_url": "/api/settings/:id", + "http_method": "GET", + "short_description": "Show a setting", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/settings/update", + "name": "update", + "apis": [ + { + "api_url": "/api/settings/:id", + "http_method": "PUT", + "short_description": "Update a setting", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "setting", + "full_name": "setting", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "value", + "full_name": "setting[value]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "compute_resources": { + "doc_url": "../apidoc/v2/compute_resources", + "api_url": "/api", + "name": "Compute resources", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/compute_resources/index", + "name": "index", + "apis": [ + { + "api_url": "/api/compute_resources", + "http_method": "GET", + "short_description": "List all compute resources", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "id", + "type": "integer" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "type", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/show", + "name": "show", + "apis": [ + { + "api_url": "/api/compute_resources/:id", + "http_method": "GET", + "short_description": "Show a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/create", + "name": "create", + "apis": [ + { + "api_url": "/api/compute_resources", + "http_method": "POST", + "short_description": "Create a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource", + "full_name": "compute_resource", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "compute_resource[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider", + "full_name": "compute_resource[provider]", + "description": "\n

Providers include EC2, Vmware, Docker

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "compute_resource[url]", + "description": "\n

URL for Docker, Libvirt, oVirt, OpenStack and Rackspace

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "compute_resource[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user", + "full_name": "compute_resource[user]", + "description": "\n

Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "compute_resource[password]", + "description": "\n

Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "compute_resource[uuid]", + "description": "\n

Deprecated, please use datacenter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "datacenter", + "full_name": "compute_resource[datacenter]", + "description": "\n

for oVirt, VMware Datacenter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_v4", + "full_name": "compute_resource[use_v4]", + "description": "\n

for oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ovirt_quota", + "full_name": "compute_resource[ovirt_quota]", + "description": "\n

for oVirt only, ID of quota to use

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "public_key", + "full_name": "compute_resource[public_key]", + "description": "\n

for oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "region", + "full_name": "compute_resource[region]", + "description": "\n

for AzureRm eg. 'eastus' and for EC2 only. Use\n'us-gov-west-1' for EC2 GovCloud region

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tenant", + "full_name": "compute_resource[tenant]", + "description": "\n

for OpenStack and AzureRm only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain", + "full_name": "compute_resource[domain]", + "description": "\n

for OpenStack (v3) only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "project_domain_name", + "full_name": "compute_resource[project_domain_name]", + "description": "\n

for OpenStack (v3) only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "project_domain_id", + "full_name": "compute_resource[project_domain_id]", + "description": "\n

for OpenStack (v3) only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "server", + "full_name": "compute_resource[server]", + "description": "\n

for VMware

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "set_console_password", + "full_name": "compute_resource[set_console_password]", + "description": "\n

for Libvirt and VMware only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "display_type", + "full_name": "compute_resource[display_type]", + "description": "\n

for Libvirt and oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: VNC, SPICE.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "keyboard", + "full_name": "compute_resource[keyboard]", + "description": "\n

for oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "caching_enabled", + "full_name": "compute_resource[caching_enabled]", + "description": "\n

enable caching, for VMware only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "project", + "full_name": "compute_resource[project]", + "description": "\n

Project id for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "email", + "full_name": "compute_resource[email]", + "description": "\n

Email for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "key_path", + "full_name": "compute_resource[key_path]", + "description": "\n

Certificate path for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "zone", + "full_name": "compute_resource[zone]", + "description": "\n

for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "compute_resource[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "compute_resource[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/update", + "name": "update", + "apis": [ + { + "api_url": "/api/compute_resources/:id", + "http_method": "PUT", + "short_description": "Update a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource", + "full_name": "compute_resource", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "compute_resource[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider", + "full_name": "compute_resource[provider]", + "description": "\n

Providers include EC2, Vmware, Docker

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "compute_resource[url]", + "description": "\n

URL for Docker, Libvirt, oVirt, OpenStack and Rackspace

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "compute_resource[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user", + "full_name": "compute_resource[user]", + "description": "\n

Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "compute_resource[password]", + "description": "\n

Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "compute_resource[uuid]", + "description": "\n

Deprecated, please use datacenter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "datacenter", + "full_name": "compute_resource[datacenter]", + "description": "\n

for oVirt, VMware Datacenter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_v4", + "full_name": "compute_resource[use_v4]", + "description": "\n

for oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ovirt_quota", + "full_name": "compute_resource[ovirt_quota]", + "description": "\n

for oVirt only, ID of quota to use

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "public_key", + "full_name": "compute_resource[public_key]", + "description": "\n

for oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "region", + "full_name": "compute_resource[region]", + "description": "\n

for AzureRm eg. 'eastus' and for EC2 only. Use\n'us-gov-west-1' for EC2 GovCloud region

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tenant", + "full_name": "compute_resource[tenant]", + "description": "\n

for OpenStack and AzureRm only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain", + "full_name": "compute_resource[domain]", + "description": "\n

for OpenStack (v3) only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "project_domain_name", + "full_name": "compute_resource[project_domain_name]", + "description": "\n

for OpenStack (v3) only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "project_domain_id", + "full_name": "compute_resource[project_domain_id]", + "description": "\n

for OpenStack (v3) only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "server", + "full_name": "compute_resource[server]", + "description": "\n

for VMware

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "set_console_password", + "full_name": "compute_resource[set_console_password]", + "description": "\n

for Libvirt and VMware only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "display_type", + "full_name": "compute_resource[display_type]", + "description": "\n

for Libvirt and oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: VNC, SPICE.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "keyboard", + "full_name": "compute_resource[keyboard]", + "description": "\n

for oVirt only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "caching_enabled", + "full_name": "compute_resource[caching_enabled]", + "description": "\n

enable caching, for VMware only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "project", + "full_name": "compute_resource[project]", + "description": "\n

Project id for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "email", + "full_name": "compute_resource[email]", + "description": "\n

Email for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "key_path", + "full_name": "compute_resource[key_path]", + "description": "\n

Certificate path for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "zone", + "full_name": "compute_resource[zone]", + "description": "\n

for GCE only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "compute_resource[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "compute_resource[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/compute_resources/:id", + "http_method": "DELETE", + "short_description": "Delete a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_images", + "name": "available_images", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_images", + "http_method": "GET", + "short_description": "List available images for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_clusters", + "name": "available_clusters", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_clusters", + "http_method": "GET", + "short_description": "List available clusters for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_flavors", + "name": "available_flavors", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_flavors", + "http_method": "GET", + "short_description": "List available flavors for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_folders", + "name": "available_folders", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_folders", + "http_method": "GET", + "short_description": "List available folders for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_zones", + "name": "available_zones", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_zones", + "http_method": "GET", + "short_description": "List available zone for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_networks", + "name": "available_networks", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_networks", + "http_method": "GET", + "short_description": "List available networks for a compute resource", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:id/available_clusters/:cluster_id/available_networks", + "http_method": "GET", + "short_description": "List available networks for a compute resource cluster", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cluster_id", + "full_name": "cluster_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_resource_pools", + "name": "available_resource_pools", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools", + "http_method": "GET", + "short_description": "List resource pools for a compute resource cluster", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cluster_id", + "full_name": "cluster_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/storage_domain", + "name": "storage_domain", + "apis": [ + { + "api_url": "/api/compute_resources/:id/storage_domains/:storage_domain_id", + "http_method": "GET", + "short_description": "List attributes for a given storage domain", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "storage_domain_id", + "full_name": "storage_domain_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_storage_domains", + "name": "available_storage_domains", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_storage_domains", + "http_method": "GET", + "short_description": "List storage domains for a compute resource", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:id/available_storage_domains/:storage_domain", + "http_method": "GET", + "short_description": "List attributes for a given storage domain", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains", + "http_method": "GET", + "short_description": "List storage domains for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cluster_id", + "full_name": "cluster_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "storage_domain", + "full_name": "storage_domain", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/storage_pod", + "name": "storage_pod", + "apis": [ + { + "api_url": "/api/compute_resources/:id/storage_pods/:storage_pod_id", + "http_method": "GET", + "short_description": "List attributes for a given storage pod", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "storage_pod_id", + "full_name": "storage_pod_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_storage_pods", + "name": "available_storage_pods", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_storage_pods", + "http_method": "GET", + "short_description": "List storage pods for a compute resource", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:id/available_storage_pods/:storage_pod", + "http_method": "GET", + "short_description": "List attributes for a given storage pod", + "deprecated": null + }, + { + "api_url": "/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods", + "http_method": "GET", + "short_description": "List storage pods for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cluster_id", + "full_name": "cluster_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "storage_pod", + "full_name": "storage_pod", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/available_security_groups", + "name": "available_security_groups", + "apis": [ + { + "api_url": "/api/compute_resources/:id/available_security_groups", + "http_method": "GET", + "short_description": "List available security groups for a compute resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/associate", + "name": "associate", + "apis": [ + { + "api_url": "/api/compute_resources/:id/associate", + "http_method": "PUT", + "short_description": "Associate VMs to Hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/compute_resources/refresh_cache", + "name": "refresh_cache", + "apis": [ + { + "api_url": "/api/compute_resources/:id/refresh_cache", + "http_method": "PUT", + "short_description": "Refresh Compute Resource Cache", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "report_templates": { + "doc_url": "../apidoc/v2/report_templates", + "api_url": "/api", + "name": "Report templates", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/report_templates/index", + "name": "index", + "apis": [ + { + "api_url": "/api/report_templates", + "http_method": "GET", + "short_description": "List all report templates", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/report_templates", + "http_method": "GET", + "short_description": "List all report templates per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/report_templates", + "http_method": "GET", + "short_description": "List all report templates per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "default", + "values": [ + "true", + "false" + ] + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "locked", + "values": [ + "true", + "false" + ] + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "snippet", + "values": [ + "true", + "false" + ] + }, + { + "name": "template", + "type": "text" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/show", + "name": "show", + "apis": [ + { + "api_url": "/api/report_templates/:id", + "http_method": "GET", + "short_description": "Show a report template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/create", + "name": "create", + "apis": [ + { + "api_url": "/api/report_templates", + "http_method": "POST", + "short_description": "Create a report template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_template", + "full_name": "report_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "report_template[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "report_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "report_template[template]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "report_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "report_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "report_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "report_template[default]", + "description": "\n

Whether or not the template is added automatically to new organizations and\nlocations

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "report_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "report_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/import", + "name": "import", + "apis": [ + { + "api_url": "/api/report_templates/import", + "http_method": "POST", + "short_description": "Import a report template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_template", + "full_name": "report_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "report_template[name]", + "description": "\n

template name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "report_template[template]", + "description": "\n

template contents including metadata

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "report_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "report_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "options", + "full_name": "options", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "force", + "full_name": "options[force]", + "description": "\n

use if you want update locked templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "associate", + "full_name": "options[associate]", + "description": "\n

determines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: new, always, never.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lock", + "full_name": "options[lock]", + "description": "\n

lock imported templates (false by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "options[default]", + "description": "\n

makes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/revision", + "name": "revision", + "apis": [ + { + "api_url": "/api/report_templates/revision", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

template version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/update", + "name": "update", + "apis": [ + { + "api_url": "/api/report_templates/:id", + "http_method": "PUT", + "short_description": "Update a report template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_template", + "full_name": "report_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "report_template[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "report_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "report_template[template]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "report_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "report_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "report_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "report_template[default]", + "description": "\n

Whether or not the template is added automatically to new organizations and\nlocations

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "report_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "report_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/report_templates/:id", + "http_method": "DELETE", + "short_description": "Delete a report template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/report_templates/:id/clone", + "http_method": "POST", + "short_description": "Clone a template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_template", + "full_name": "report_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "report_template[name]", + "description": "\n

template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/export", + "name": "export", + "apis": [ + { + "api_url": "/api/report_templates/:id/export", + "http_method": "GET", + "short_description": "Export a report template to ERB", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/generate", + "name": "generate", + "apis": [ + { + "api_url": "/api/report_templates/:id/generate", + "http_method": "POST", + "short_description": "Generate report from a template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "input_values", + "full_name": "input_values", + "description": "\n

Hash of input values where key is the name of input, value is the value for\nthis input

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gzip", + "full_name": "gzip", + "description": "\n

Compress the report uzing gzip

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_format", + "full_name": "report_format", + "description": "\n

Report format, defaults to 'csv'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: csv, json, yaml, html.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/schedule_report", + "name": "schedule_report", + "apis": [ + { + "api_url": "/api/report_templates/:id/schedule_report", + "http_method": "POST", + "short_description": "Schedule generating of a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

The reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\nreport_data).

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "input_values", + "full_name": "input_values", + "description": "\n

Hash of input values where key is the name of input, value is the value for\nthis input

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gzip", + "full_name": "gzip", + "description": "\n

Compress the report using gzip

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mail_to", + "full_name": "mail_to", + "description": "\n

If set, scheduled report will be delivered via e-mail. Use ',' to\nseparate multiple email addresses.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "generate_at", + "full_name": "generate_at", + "description": "\n

UTC time to generate report at

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_format", + "full_name": "report_format", + "description": "\n

Report format, defaults to 'csv'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: csv, json, yaml, html.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [ + { + "code": 200, + "description": "a successful response", + "is_array": false, + "returns_object": [ + { + "name": "job_id", + "full_name": "job_id", + "description": "\n

An ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true + }, + { + "name": "data_url", + "full_name": "data_url", + "description": "\n

An url to get resulting report from. This is not available when report is\ndelivered via e-mail.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true + } + ], + "additional_properties": false + } + ], + "examples": [ + "POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n" + ], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/report_templates/report_data", + "name": "report_data", + "apis": [ + { + "api_url": "/api/report_templates/:id/report_data/:job_id", + "http_method": "GET", + "short_description": "Downloads a generated report", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Returns the report data as a raw response. In case the report hasn't\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_id", + "full_name": "job_id", + "description": "\n

ID assigned to generating job by the schedule command

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "config_groups": { + "doc_url": "../apidoc/v2/config_groups", + "api_url": "/api", + "name": "Config groups", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/config_groups/index", + "name": "index", + "apis": [ + { + "api_url": "/api/config_groups", + "http_method": "GET", + "short_description": "List of config groups", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "class", + "type": "string" + }, + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_groups/show", + "name": "show", + "apis": [ + { + "api_url": "/api/config_groups/:id", + "http_method": "GET", + "short_description": "Show a config group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_groups/create", + "name": "create", + "apis": [ + { + "api_url": "/api/config_groups", + "http_method": "POST", + "short_description": "Create a config group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_group", + "full_name": "config_group", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "config_group[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_ids", + "full_name": "config_group[puppetclass_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_groups/update", + "name": "update", + "apis": [ + { + "api_url": "/api/config_groups/:id", + "http_method": "PUT", + "short_description": "Update a config group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_group", + "full_name": "config_group", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "config_group[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_ids", + "full_name": "config_group[puppetclass_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_groups/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/config_groups/:id", + "http_method": "DELETE", + "short_description": "Delete a config group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "subnets": { + "doc_url": "../apidoc/v2/subnets", + "api_url": "/api", + "name": "Subnets", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/subnets/index", + "name": "index", + "apis": [ + { + "api_url": "/api/subnets", + "http_method": "GET", + "short_description": "List of subnets", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/subnets", + "http_method": "GET", + "short_description": "List of subnets for a domain", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/subnets", + "http_method": "GET", + "short_description": "List of subnets per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/subnets", + "http_method": "GET", + "short_description": "List of subnets per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "boot_mode", + "type": "string" + }, + { + "name": "dns_primary", + "type": "string" + }, + { + "name": "dns_secondary", + "type": "string" + }, + { + "name": "domain", + "type": "string" + }, + { + "name": "gateway", + "type": "string" + }, + { + "name": "ipam", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "mask", + "type": "string" + }, + { + "name": "mtu", + "type": "integer" + }, + { + "name": "name", + "type": "text" + }, + { + "name": "network", + "type": "string" + }, + { + "name": "nic_delay", + "type": "integer" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "params", + "type": "text" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "vlanid", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subnets/show", + "name": "show", + "apis": [ + { + "api_url": "/api/subnets/:id", + "http_method": "GET", + "short_description": "Show a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden_parameters", + "full_name": "show_hidden_parameters", + "description": "\n

Display hidden parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subnets/create", + "name": "create", + "apis": [ + { + "api_url": "/api/subnets", + "http_method": "POST", + "short_description": "Create a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet", + "full_name": "subnet", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "subnet[name]", + "description": "\n

Subnet name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "subnet[description]", + "description": "\n

Subnet description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "network_type", + "full_name": "subnet[network_type]", + "description": "\n

Type or protocol, IPv4 or IPv6, defaults to IPv4

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: IPv4, IPv6.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "network", + "full_name": "subnet[network]", + "description": "\n

Subnet network

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mask", + "full_name": "subnet[mask]", + "description": "\n

Netmask for this subnet

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gateway", + "full_name": "subnet[gateway]", + "description": "\n

Subnet gateway

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_primary", + "full_name": "subnet[dns_primary]", + "description": "\n

Primary DNS for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_secondary", + "full_name": "subnet[dns_secondary]", + "description": "\n

Secondary DNS for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ipam", + "full_name": "subnet[ipam]", + "description": "\n

IP Address auto suggestion mode for this subnet.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: DHCP, Internal DB, Random DB, EUI-64, None.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "from", + "full_name": "subnet[from]", + "description": "\n

Starting IP Address for IP auto suggestion

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "to", + "full_name": "subnet[to]", + "description": "\n

Ending IP Address for IP auto suggestion

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "vlanid", + "full_name": "subnet[vlanid]", + "description": "\n

VLAN ID for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mtu", + "full_name": "subnet[mtu]", + "description": "\n

MTU for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_ids", + "full_name": "subnet[domain_ids]", + "description": "\n

Domains in which this subnet is part

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dhcp_id", + "full_name": "subnet[dhcp_id]", + "description": "\n

DHCP Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tftp_id", + "full_name": "subnet[tftp_id]", + "description": "\n

TFTP Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "httpboot_id", + "full_name": "subnet[httpboot_id]", + "description": "\n

HTTPBoot Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_id", + "full_name": "subnet[dns_id]", + "description": "\n

DNS Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "subnet[template_id]", + "description": "\n

Template HTTP(S) Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "discovery_id", + "full_name": "subnet[discovery_id]", + "description": "\n

ID of Discovery Proxy to use within this subnet for managing connection to\ndiscovered hosts

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "boot_mode", + "full_name": "subnet[boot_mode]", + "description": "\n

Default boot mode for interfaces assigned to this subnet.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: Static, DHCP.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_parameters_attributes", + "full_name": "subnet[subnet_parameters_attributes]", + "description": "\n

Array of parameters (name, value)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "subnet[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "subnet[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subnets/update", + "name": "update", + "apis": [ + { + "api_url": "/api/subnets/:id", + "http_method": "PUT", + "short_description": "Update a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Subnet numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet", + "full_name": "subnet", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "subnet[name]", + "description": "\n

Subnet name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "subnet[description]", + "description": "\n

Subnet description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "network_type", + "full_name": "subnet[network_type]", + "description": "\n

Type or protocol, IPv4 or IPv6, defaults to IPv4

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: IPv4, IPv6.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "network", + "full_name": "subnet[network]", + "description": "\n

Subnet network

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mask", + "full_name": "subnet[mask]", + "description": "\n

Netmask for this subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gateway", + "full_name": "subnet[gateway]", + "description": "\n

Subnet gateway

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_primary", + "full_name": "subnet[dns_primary]", + "description": "\n

Primary DNS for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_secondary", + "full_name": "subnet[dns_secondary]", + "description": "\n

Secondary DNS for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ipam", + "full_name": "subnet[ipam]", + "description": "\n

IP Address auto suggestion mode for this subnet.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: DHCP, Internal DB, Random DB, EUI-64, None.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "from", + "full_name": "subnet[from]", + "description": "\n

Starting IP Address for IP auto suggestion

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "to", + "full_name": "subnet[to]", + "description": "\n

Ending IP Address for IP auto suggestion

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "vlanid", + "full_name": "subnet[vlanid]", + "description": "\n

VLAN ID for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mtu", + "full_name": "subnet[mtu]", + "description": "\n

MTU for this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_ids", + "full_name": "subnet[domain_ids]", + "description": "\n

Domains in which this subnet is part

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dhcp_id", + "full_name": "subnet[dhcp_id]", + "description": "\n

DHCP Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "tftp_id", + "full_name": "subnet[tftp_id]", + "description": "\n

TFTP Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "httpboot_id", + "full_name": "subnet[httpboot_id]", + "description": "\n

HTTPBoot Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_id", + "full_name": "subnet[dns_id]", + "description": "\n

DNS Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "subnet[template_id]", + "description": "\n

Template HTTP(S) Proxy ID to use within this subnet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "discovery_id", + "full_name": "subnet[discovery_id]", + "description": "\n

ID of Discovery Proxy to use within this subnet for managing connection to\ndiscovered hosts

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "boot_mode", + "full_name": "subnet[boot_mode]", + "description": "\n

Default boot mode for interfaces assigned to this subnet.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: Static, DHCP.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_parameters_attributes", + "full_name": "subnet[subnet_parameters_attributes]", + "description": "\n

Array of parameters (name, value)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "subnet[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "subnet[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subnets/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/subnets/:id", + "http_method": "DELETE", + "short_description": "Delete a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Subnet numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subnets/freeip", + "name": "freeip", + "apis": [ + { + "api_url": "/api/subnets/:id/freeip", + "http_method": "GET", + "short_description": "Provides an unused IP address in this subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mac", + "full_name": "mac", + "description": "\n

MAC address to reuse the IP for this host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "excluded_ips", + "full_name": "excluded_ips", + "description": "\n

IP addresses that should be excluded from suggestion

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "config_reports": { + "doc_url": "../apidoc/v2/config_reports", + "api_url": "/api", + "name": "Config reports", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/config_reports/index", + "name": "index", + "apis": [ + { + "api_url": "/api/config_reports", + "http_method": "GET", + "short_description": "List all reports", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "applied", + "type": "integer" + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "eventful", + "values": [ + "true", + "false" + ] + }, + { + "name": "failed", + "type": "integer" + }, + { + "name": "failed_restarts", + "type": "integer" + }, + { + "name": "host", + "type": "string" + }, + { + "name": "host_id", + "type": "integer" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "hostgroup_fullname", + "type": "string" + }, + { + "name": "hostgroup_title", + "type": "string" + }, + { + "name": "last_report", + "type": "datetime" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "log", + "type": "text" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "origin", + "type": "string" + }, + { + "name": "pending", + "type": "integer" + }, + { + "name": "reported", + "type": "datetime" + }, + { + "name": "resource", + "type": "text" + }, + { + "name": "restarted", + "type": "integer" + }, + { + "name": "skipped", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_reports/show", + "name": "show", + "apis": [ + { + "api_url": "/api/config_reports/:id", + "http_method": "GET", + "short_description": "Show a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_reports/create", + "name": "create", + "apis": [ + { + "api_url": "/api/config_reports", + "http_method": "POST", + "short_description": "Create a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_report", + "full_name": "config_report", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "host", + "full_name": "config_report[host]", + "description": "\n

Hostname or certname

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "reported_at", + "full_name": "config_report[reported_at]", + "description": "\n

UTC time of report

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "status", + "full_name": "config_report[status]", + "description": "\n

Hash of status type totals

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "metrics", + "full_name": "config_report[metrics]", + "description": "\n

Hash of report metrics, can be just {}

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "logs", + "full_name": "config_report[logs]", + "description": "\n

Optional array of log hashes

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_reports/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/config_reports/:id", + "http_method": "DELETE", + "short_description": "Delete a report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_reports/last", + "name": "last", + "apis": [ + { + "api_url": "/api/hosts/:host_id/config_reports/last", + "http_method": "GET", + "short_description": "Show the last report for a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "tasks": { + "doc_url": "../apidoc/v2/tasks", + "api_url": "/api", + "name": "Tasks", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/tasks/index", + "name": "index", + "apis": [ + { + "api_url": "/api/orchestration/:id/tasks", + "http_method": "GET", + "short_description": "List all tasks for a given orchestration event", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "config_templates": { + "doc_url": "../apidoc/v2/config_templates", + "api_url": "/api", + "name": "Config templates", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/config_templates/index", + "name": "index", + "apis": [ + { + "api_url": "/api/config_templates", + "http_method": "GET", + "short_description": "List provisioning templates", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/config_templates", + "http_method": "GET", + "short_description": "List provisioning templates per operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/config_templates", + "http_method": "GET", + "short_description": "List provisioning templates per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/config_templates", + "http_method": "GET", + "short_description": "List provisioning templates per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "default_template", + "values": [ + "true", + "false" + ] + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "kind", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "locked", + "values": [ + "true", + "false" + ] + }, + { + "name": "name", + "type": "string" + }, + { + "name": "operatingsystem", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "snippet", + "values": [ + "true", + "false" + ] + }, + { + "name": "template", + "type": "text" + }, + { + "name": "vendor", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/show", + "name": "show", + "apis": [ + { + "api_url": "/api/config_templates/:id", + "http_method": "GET", + "short_description": "Show provisioning template details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/create", + "name": "create", + "apis": [ + { + "api_url": "/api/config_templates", + "http_method": "POST", + "short_description": "Create a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template", + "full_name": "config_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "config_template[name]", + "description": "\n

template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "config_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "config_template[template]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "config_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "config_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_kind_id", + "full_name": "config_template[template_kind_id]", + "description": "\n

not relevant for snippet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_combinations_attributes", + "full_name": "config_template[template_combinations_attributes]", + "description": "\n

Array of template combinations (hostgroup_id, environment_id)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "config_template[operatingsystem_ids]", + "description": "\n

Array of operating system IDs to associate with the template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "config_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "config_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "config_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/update", + "name": "update", + "apis": [ + { + "api_url": "/api/config_templates/:id", + "http_method": "PUT", + "short_description": "Update a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template", + "full_name": "config_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "config_template[name]", + "description": "\n

template name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "config_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "config_template[template]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "config_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "config_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_kind_id", + "full_name": "config_template[template_kind_id]", + "description": "\n

not relevant for snippet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_combinations_attributes", + "full_name": "config_template[template_combinations_attributes]", + "description": "\n

Array of template combinations (hostgroup_id, environment_id)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "config_template[operatingsystem_ids]", + "description": "\n

Array of operating system IDs to associate with the template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "config_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "config_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "config_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/revision", + "name": "revision", + "apis": [ + { + "api_url": "/api/config_templates/revision", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

template version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/config_templates/:id", + "http_method": "DELETE", + "short_description": "Delete a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/build_pxe_default", + "name": "build_pxe_default", + "apis": [ + { + "api_url": "/api/config_templates/build_pxe_default", + "http_method": "POST", + "short_description": "Update the default PXE menu on all configured TFTP servers", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/config_templates/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/config_templates/:id/clone", + "http_method": "POST", + "short_description": "Clone a provision template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template", + "full_name": "config_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "config_template[name]", + "description": "\n

template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "template_inputs": { + "doc_url": "../apidoc/v2/template_inputs", + "api_url": "/api", + "name": "Template inputs", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/template_inputs/index", + "name": "index", + "apis": [ + { + "api_url": "/api/templates/:template_id/template_inputs", + "http_method": "GET", + "short_description": "List template inputs", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_inputs/show", + "name": "show", + "apis": [ + { + "api_url": "/api/templates/:template_id/template_inputs/:id", + "http_method": "GET", + "short_description": "Show template input details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_inputs/create", + "name": "create", + "apis": [ + { + "api_url": "/api/templates/:template_id/template_inputs", + "http_method": "POST", + "short_description": "Create a template input", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_input", + "full_name": "template_input", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "template_input[name]", + "description": "\n

Input name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "template_input[description]", + "description": "\n

Input description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "required", + "full_name": "template_input[required]", + "description": "\n

Input is required

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "advanced", + "full_name": "template_input[advanced]", + "description": "\n

Input is advanced

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "input_type", + "full_name": "template_input[input_type]", + "description": "\n

Input type

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: user, fact, variable, puppet_parameter.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "fact_name", + "full_name": "template_input[fact_name]", + "description": "\n

Fact name, used when input type is fact

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "variable_name", + "full_name": "template_input[variable_name]", + "description": "\n

Variable name, used when input type is variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_class_name", + "full_name": "template_input[puppet_class_name]", + "description": "\n

Puppet class name, used when input type is puppet_parameter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_parameter_name", + "full_name": "template_input[puppet_parameter_name]", + "description": "\n

Puppet parameter name, used when input type is puppet_parameter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "options", + "full_name": "template_input[options]", + "description": "\n

Selectable values for user inputs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "template_input[default]", + "description": "\n

Default value for user input

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value_type", + "full_name": "template_input[value_type]", + "description": "\n

Value type, defaults to plain

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: plain, search, date.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "resource_type", + "full_name": "template_input[resource_type]", + "description": "\n

For values of type search, this is the resource the value searches in

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: AnsibleRole, AnsibleVariable, Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigGroup, ConfigReport, Container, DiscoveryRule, DockerRegistry, Domain, Environment, ExternalUsergroup, FactValue, Filter, ForemanTasks::RecurringLogic, ForemanTasks::Task, ForemanVirtWhoConfigure::Config, Host, HostClass, Hostgroup, HttpProxy, Image, JobInvocation, JobTemplate, Katello::ActivationKey, Katello::ContentView, Katello::GpgKey, Katello::HostCollection, Katello::KTEnvironment, Katello::Product, Katello::Subscription, Katello::SyncPlan, KeyPair, Location, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, PuppetclassLookupKey, Realm, RemoteExecutionFeature, Report, ReportTemplate, Role, SccAccount, Setting, SmartProxy, SshKey, Subnet, Template, TemplateInvocation, Trend, User, Usergroup, VariableLookupKey.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_inputs/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/templates/:template_id/template_inputs/:id", + "http_method": "DELETE", + "short_description": "Delete a template input", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_inputs/update", + "name": "update", + "apis": [ + { + "api_url": "/api/templates/:template_id/template_inputs/:id", + "http_method": "PUT", + "short_description": "Update a template input", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_input", + "full_name": "template_input", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "template_input[name]", + "description": "\n

Input name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "template_input[description]", + "description": "\n

Input description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "required", + "full_name": "template_input[required]", + "description": "\n

Input is required

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "advanced", + "full_name": "template_input[advanced]", + "description": "\n

Input is advanced

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "input_type", + "full_name": "template_input[input_type]", + "description": "\n

Input type

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: user, fact, variable, puppet_parameter.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "fact_name", + "full_name": "template_input[fact_name]", + "description": "\n

Fact name, used when input type is fact

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "variable_name", + "full_name": "template_input[variable_name]", + "description": "\n

Variable name, used when input type is variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_class_name", + "full_name": "template_input[puppet_class_name]", + "description": "\n

Puppet class name, used when input type is puppet_parameter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_parameter_name", + "full_name": "template_input[puppet_parameter_name]", + "description": "\n

Puppet parameter name, used when input type is puppet_parameter

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "options", + "full_name": "template_input[options]", + "description": "\n

Selectable values for user inputs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "template_input[default]", + "description": "\n

Default value for user input

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value_type", + "full_name": "template_input[value_type]", + "description": "\n

Value type, defaults to plain

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: plain, search, date.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "resource_type", + "full_name": "template_input[resource_type]", + "description": "\n

For values of type search, this is the resource the value searches in

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: AnsibleRole, AnsibleVariable, Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigGroup, ConfigReport, Container, DiscoveryRule, DockerRegistry, Domain, Environment, ExternalUsergroup, FactValue, Filter, ForemanTasks::RecurringLogic, ForemanTasks::Task, ForemanVirtWhoConfigure::Config, Host, HostClass, Hostgroup, HttpProxy, Image, JobInvocation, JobTemplate, Katello::ActivationKey, Katello::ContentView, Katello::GpgKey, Katello::HostCollection, Katello::KTEnvironment, Katello::Product, Katello::Subscription, Katello::SyncPlan, KeyPair, Location, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Puppetclass, PuppetclassLookupKey, Realm, RemoteExecutionFeature, Report, ReportTemplate, Role, SccAccount, Setting, SmartProxy, SshKey, Subnet, Template, TemplateInvocation, Trend, User, Usergroup, VariableLookupKey.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "dashboard": { + "doc_url": "../apidoc/v2/dashboard", + "api_url": "/api", + "name": "Dashboard", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/dashboard/index", + "name": "index", + "apis": [ + { + "api_url": "/api/dashboard", + "http_method": "GET", + "short_description": "Get dashboard details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "trends": { + "doc_url": "../apidoc/v2/trends", + "api_url": "/api", + "name": "Trends", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/trends/index", + "name": "index", + "apis": [ + { + "api_url": "/api/trends", + "http_method": "GET", + "short_description": "List of trends counters", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/trends/show", + "name": "show", + "apis": [ + { + "api_url": "/api/trends/:id", + "http_method": "GET", + "short_description": "Show a trend", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "trend_id", + "full_name": "trend_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/trends/create", + "name": "create", + "apis": [ + { + "api_url": "/api/trends", + "http_method": "POST", + "short_description": "Create a trend counter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "trendable_type", + "full_name": "trendable_type", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "fact_name", + "full_name": "fact_name", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/trends/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/trends/:id", + "http_method": "DELETE", + "short_description": "Delete a trend counter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "domains": { + "doc_url": "../apidoc/v2/domains", + "api_url": "/api", + "name": "Domains", + "short_description": null, + "full_description": "\n

foreman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\nhostname.somewhere.com then the domain is\nsomewhere.com. This allows foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/domains/index", + "name": "index", + "apis": [ + { + "api_url": "/api/domains", + "http_method": "GET", + "short_description": "List of domains", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/domains", + "http_method": "GET", + "short_description": "List of domains per subnet", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/domains", + "http_method": "GET", + "short_description": "List of domains per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/domains", + "http_method": "GET", + "short_description": "List of domains per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "fullname", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "params", + "type": "text" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/domains/show", + "name": "show", + "apis": [ + { + "api_url": "/api/domains/:id", + "http_method": "GET", + "short_description": "Show a domain", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Numerical ID or domain name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden_parameters", + "full_name": "show_hidden_parameters", + "description": "\n

Display hidden parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/domains/create", + "name": "create", + "apis": [ + { + "api_url": "/api/domains", + "http_method": "POST", + "short_description": "Create a domain", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

The fullname field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain", + "full_name": "domain", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "domain[name]", + "description": "\n

The full DNS domain name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "fullname", + "full_name": "domain[fullname]", + "description": "\n

Description of the domain

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_id", + "full_name": "domain[dns_id]", + "description": "\n

DNS proxy ID to use within this domain

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_parameters_attributes", + "full_name": "domain[domain_parameters_attributes]", + "description": "\n

Array of parameters (name, value)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "domain[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "domain[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/domains/update", + "name": "update", + "apis": [ + { + "api_url": "/api/domains/:id", + "http_method": "PUT", + "short_description": "Update a domain", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain", + "full_name": "domain", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "domain[name]", + "description": "\n

The full DNS domain name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "fullname", + "full_name": "domain[fullname]", + "description": "\n

Description of the domain

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dns_id", + "full_name": "domain[dns_id]", + "description": "\n

DNS proxy ID to use within this domain

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_parameters_attributes", + "full_name": "domain[domain_parameters_attributes]", + "description": "\n

Array of parameters (name, value)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "domain[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "domain[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/domains/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/domains/:id", + "http_method": "DELETE", + "short_description": "Delete a domain", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "ping": { + "doc_url": "../apidoc/v2/ping", + "api_url": "/api", + "name": "Ping", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ping/ping", + "name": "ping", + "apis": [ + { + "api_url": "/api/ping", + "http_method": "GET", + "short_description": "Shows status of foreman system and it's subcomponents", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

This service is available for unauthenticated users

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ping/statuses", + "name": "statuses", + "apis": [ + { + "api_url": "/api/statuses", + "http_method": "GET", + "short_description": "Shows status and version information of foreman system and it's subcomponents", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

This service is only available for authenticated users

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ping/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/ping", + "http_method": "GET", + "short_description": "Shows status of foreman system and it's subcomponents", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

This service is only available for authenticated users

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ping/server_status", + "name": "server_status", + "apis": [ + { + "api_url": "/katello/api/status", + "http_method": "GET", + "short_description": "Shows version information", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

This service is available for unauthenticated users

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "environments": { + "doc_url": "../apidoc/v2/environments", + "api_url": "/api", + "name": "Environments", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/environments/import_puppetclasses", + "name": "import_puppetclasses", + "apis": [ + { + "api_url": "/api/smart_proxies/:id/import_puppetclasses", + "http_method": "POST", + "short_description": "Import puppet classes from puppet proxy", + "deprecated": null + }, + { + "api_url": "/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses", + "http_method": "POST", + "short_description": "Import puppet classes from puppet proxy for an environment", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses", + "http_method": "POST", + "short_description": "Import puppet classes from puppet proxy for an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy_id", + "full_name": "smart_proxy_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dryrun", + "full_name": "dryrun", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "except", + "full_name": "except", + "description": "\n

Optional comma-delimited string containing either 'new',\n'updated', or 'obsolete' that is used to limit the imported\nPuppet classes

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/environments/index", + "name": "index", + "apis": [ + { + "api_url": "/api/environments", + "http_method": "GET", + "short_description": "List all environments", + "deprecated": null + }, + { + "api_url": "/api/puppetclasses/:puppetclass_id/environments", + "http_method": "GET", + "short_description": "List environments of Puppet class", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/environments", + "http_method": "GET", + "short_description": "List environments per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/environments", + "http_method": "GET", + "short_description": "List environments per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "puppetclass_id", + "full_name": "puppetclass_id", + "description": "\n

ID of Puppet class

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "content_view", + "type": "string" + }, + { + "name": "lifecycle_environment", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/environments/show", + "name": "show", + "apis": [ + { + "api_url": "/api/environments/:id", + "http_method": "GET", + "short_description": "Show an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/environments/create", + "name": "create", + "apis": [ + { + "api_url": "/api/environments", + "http_method": "POST", + "short_description": "Create an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment", + "full_name": "environment", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "environment[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "environment[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "environment[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/environments/update", + "name": "update", + "apis": [ + { + "api_url": "/api/environments/:id", + "http_method": "PUT", + "short_description": "Update an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment", + "full_name": "environment", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "environment[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "environment[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "environment[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/environments/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/environments/:id", + "http_method": "DELETE", + "short_description": "Delete an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "template_combinations": { + "doc_url": "../apidoc/v2/template_combinations", + "api_url": "/api", + "name": "Template combinations", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/template_combinations/index", + "name": "index", + "apis": [ + { + "api_url": "/api/config_templates/:config_template_id/template_combinations", + "http_method": "GET", + "short_description": "List template combination", + "deprecated": true + }, + { + "api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations", + "http_method": "GET", + "short_description": "List template combination", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/template_combinations", + "http_method": "GET", + "short_description": "List template combination", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/template_combinations", + "http_method": "GET", + "short_description": "List template combination", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "config_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "provisioning_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_combinations/create", + "name": "create", + "apis": [ + { + "api_url": "/api/config_templates/:config_template_id/template_combinations", + "http_method": "POST", + "short_description": "Add a template combination", + "deprecated": true + }, + { + "api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations", + "http_method": "POST", + "short_description": "Add a template combination", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/template_combinations", + "http_method": "POST", + "short_description": "Add a template combination", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/template_combinations", + "http_method": "POST", + "short_description": "Add a template combination", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "config_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "provisioning_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_combination", + "full_name": "template_combination", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "environment_id", + "full_name": "template_combination[environment_id]", + "description": "\n

environment id

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "template_combination[hostgroup_id]", + "description": "\n

host group id

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_combinations/show", + "name": "show", + "apis": [ + { + "api_url": "/api/template_combinations/:id", + "http_method": "GET", + "short_description": "Show template combination", + "deprecated": null + }, + { + "api_url": "/api/config_templates/:config_template_id/template_combinations/:id", + "http_method": "GET", + "short_description": "Show template combination", + "deprecated": true + }, + { + "api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations/:id", + "http_method": "GET", + "short_description": "Show template combination", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/template_combinations/:id", + "http_method": "GET", + "short_description": "Show template combination", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/template_combinations/:id", + "http_method": "GET", + "short_description": "Show template combination", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "config_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "provisioning_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_combinations/update", + "name": "update", + "apis": [ + { + "api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations/:id", + "http_method": "PUT", + "short_description": "Update template combination", + "deprecated": null + }, + { + "api_url": "/api/config_templates/:config_template_id/template_combinations/:id", + "http_method": "PUT", + "short_description": "Update template combination", + "deprecated": true + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/template_combinations/:id", + "http_method": "PUT", + "short_description": "Update template combination", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/template_combinations/:id", + "http_method": "PUT", + "short_description": "Update template combination", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "config_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "provisioning_template_id", + "description": "\n

ID of config template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_combination", + "full_name": "template_combination", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "environment_id", + "full_name": "template_combination[environment_id]", + "description": "\n

environment id

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "template_combination[hostgroup_id]", + "description": "\n

host group id

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template_combinations/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/template_combinations/:id", + "http_method": "DELETE", + "short_description": "Delete a template combination", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "external_usergroups": { + "doc_url": "../apidoc/v2/external_usergroups", + "api_url": "/api", + "name": "External usergroups", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/external_usergroups/index", + "name": "index", + "apis": [ + { + "api_url": "/api/usergroups/:usergroup_id/external_usergroups", + "http_method": "GET", + "short_description": "List all external user groups for user group", + "deprecated": null + }, + { + "api_url": "/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups", + "http_method": "GET", + "short_description": "List all external user groups for LDAP authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID or name of user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/external_usergroups/show", + "name": "show", + "apis": [ + { + "api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id", + "http_method": "GET", + "short_description": "Show an external user group for user group", + "deprecated": null + }, + { + "api_url": "/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id", + "http_method": "GET", + "short_description": "Show an external user group for LDAP authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID or name of user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID or name of external user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/external_usergroups/create", + "name": "create", + "apis": [ + { + "api_url": "/api/usergroups/:usergroup_id/external_usergroups", + "http_method": "POST", + "short_description": "Create an external user group linked to a user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID or name of user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "external_usergroup", + "full_name": "external_usergroup", + "description": "\n

External user group information

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "external_usergroup[name]", + "description": "\n

External user group name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_id", + "full_name": "external_usergroup[auth_source_id]", + "description": "\n

ID of linked authentication source

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/external_usergroups/update", + "name": "update", + "apis": [ + { + "api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id", + "http_method": "PUT", + "short_description": "Update external user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID or name of user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID or name of external user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "external_usergroup", + "full_name": "external_usergroup", + "description": "\n

External user group information

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "external_usergroup[name]", + "description": "\n

External user group name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_id", + "full_name": "external_usergroup[auth_source_id]", + "description": "\n

ID of linked authentication source

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/external_usergroups/refresh", + "name": "refresh", + "apis": [ + { + "api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id/refresh", + "http_method": "PUT", + "short_description": "Refresh external user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID or name of user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID or name of external user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/external_usergroups/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id", + "http_method": "DELETE", + "short_description": "Delete an external user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID or name of user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID or name external user group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "filters": { + "doc_url": "../apidoc/v2/filters", + "api_url": "/api", + "name": "Filters", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/filters/index", + "name": "index", + "apis": [ + { + "api_url": "/api/filters", + "http_method": "GET", + "short_description": "List all filters", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "limited", + "values": [ + "true", + "false" + ] + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "override", + "values": [ + "true", + "false" + ] + }, + { + "name": "permission", + "type": "string" + }, + { + "name": "resource", + "type": "string" + }, + { + "name": "role", + "type": "string" + }, + { + "name": "role_id", + "type": "integer" + }, + { + "name": "search", + "type": "text" + }, + { + "name": "unlimited", + "values": [ + "true", + "false" + ] + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/filters/show", + "name": "show", + "apis": [ + { + "api_url": "/api/filters/:id", + "http_method": "GET", + "short_description": "Show a filter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/filters/create", + "name": "create", + "apis": [ + { + "api_url": "/api/filters", + "http_method": "POST", + "short_description": "Create a filter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filter", + "full_name": "filter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "role_id", + "full_name": "filter[role_id]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "filter[search]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override", + "full_name": "filter[override]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "permission_ids", + "full_name": "filter[permission_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "filter[organization_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "filter[location_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/filters/update", + "name": "update", + "apis": [ + { + "api_url": "/api/filters/:id", + "http_method": "PUT", + "short_description": "Update a filter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filter", + "full_name": "filter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "role_id", + "full_name": "filter[role_id]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "filter[search]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override", + "full_name": "filter[override]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "permission_ids", + "full_name": "filter[permission_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "filter[organization_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "filter[location_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/filters/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/filters/:id", + "http_method": "DELETE", + "short_description": "Delete a filter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "home": { + "doc_url": "../apidoc/v2/home", + "api_url": "/api", + "name": "Home", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/home/index", + "name": "index", + "apis": [ + { + "api_url": "/api", + "http_method": "GET", + "short_description": "Show available API links", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/home/status", + "name": "status", + "apis": [ + { + "api_url": "/api/status", + "http_method": "GET", + "short_description": "Show status", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "host_classes": { + "doc_url": "../apidoc/v2/host_classes", + "api_url": "/api", + "name": "Host classes", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_classes/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/puppetclass_ids", + "http_method": "GET", + "short_description": "List all Puppet class IDs for host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_classes/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hosts/:host_id/puppetclass_ids", + "http_method": "POST", + "short_description": "Add a Puppet class to host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_id", + "full_name": "puppetclass_id", + "description": "\n

ID of Puppet class

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_classes/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hosts/:host_id/puppetclass_ids/:id", + "http_method": "DELETE", + "short_description": "Remove a Puppet class from host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of Puppet class

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "template_kinds": { + "doc_url": "../apidoc/v2/template_kinds", + "api_url": "/api", + "name": "Template kinds", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/template_kinds/index", + "name": "index", + "apis": [ + { + "api_url": "/api/template_kinds", + "http_method": "GET", + "short_description": "List all template kinds", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "hostgroup_classes": { + "doc_url": "../apidoc/v2/hostgroup_classes", + "api_url": "/api", + "name": "Hostgroup classes", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/hostgroup_classes/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hostgroups/:hostgroup_id/puppetclass_ids", + "http_method": "GET", + "short_description": "List all Puppet class IDs for host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroup_classes/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hostgroups/:hostgroup_id/puppetclass_ids", + "http_method": "POST", + "short_description": "Add a Puppet class to host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_id", + "full_name": "puppetclass_id", + "description": "\n

ID of Puppet class

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hostgroup_classes/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hostgroups/:hostgroup_id/puppetclass_ids/:id", + "http_method": "DELETE", + "short_description": "Remove a Puppet class from host group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of Puppet class

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "images": { + "doc_url": "../apidoc/v2/images", + "api_url": "/api", + "name": "Images", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/images/index", + "name": "index", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/images", + "http_method": "GET", + "short_description": "List all images for a compute resource", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/images", + "http_method": "GET", + "short_description": "List all images for operating system", + "deprecated": null + }, + { + "api_url": "/api/architectures/:architecture_id/images", + "http_method": "GET", + "short_description": "List all images for architecture", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "\n

ID of compute resource

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "architecture_id", + "description": "\n

ID of architecture

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "architecture", + "type": "integer" + }, + { + "name": "compute_resource", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "operatingsystem", + "type": "integer" + }, + { + "name": "user_data", + "values": [ + "true", + "false" + ] + }, + { + "name": "username", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/images/show", + "name": "show", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/images/:id", + "http_method": "GET", + "short_description": "Show an image", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/images/:id", + "http_method": "GET", + "short_description": "Show an image", + "deprecated": null + }, + { + "api_url": "/api/architectures/:architecture_id/images/:id", + "http_method": "GET", + "short_description": "Show an image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "\n

ID of compute resource

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "architecture_id", + "description": "\n

ID of architecture

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/images/create", + "name": "create", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/images", + "http_method": "POST", + "short_description": "Create an image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "image", + "full_name": "image", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "image[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "image[username]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "image[uuid]", + "description": "\n

Template ID in the compute resource

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "image[password]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "image[compute_resource_id]", + "description": "\n

ID of compute resource

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "image[architecture_id]", + "description": "\n

ID of architecture

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "image[operatingsystem_id]", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_data", + "full_name": "image[user_data]", + "description": "\n

Whether or not the image supports user data

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/images/update", + "name": "update", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/images/:id", + "http_method": "PUT", + "short_description": "Update an image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "image", + "full_name": "image", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "image[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "username", + "full_name": "image[username]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "image[uuid]", + "description": "\n

Template ID in the compute resource

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "image[password]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "image[compute_resource_id]", + "description": "\n

ID of compute resource

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "image[architecture_id]", + "description": "\n

ID of architecture

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "image[operatingsystem_id]", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_data", + "full_name": "image[user_data]", + "description": "\n

Whether or not the image supports user data

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/images/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/compute_resources/:compute_resource_id/images/:id", + "http_method": "DELETE", + "short_description": "Delete an image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_id", + "full_name": "compute_resource_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "locations": { + "doc_url": "../apidoc/v2/locations", + "api_url": "/api", + "name": "Locations", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/locations/index", + "name": "index", + "apis": [ + { + "api_url": "/api/locations", + "http_method": "GET", + "short_description": "List all locations", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/locations/show", + "name": "show", + "apis": [ + { + "api_url": "/api/locations/:id", + "http_method": "GET", + "short_description": "Show a location", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden_parameters", + "full_name": "show_hidden_parameters", + "description": "\n

Display hidden parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/locations/create", + "name": "create", + "apis": [ + { + "api_url": "/api/locations", + "http_method": "POST", + "short_description": "Create a location", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location", + "full_name": "location", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "location[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "location[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_ids", + "full_name": "location[user_ids]", + "description": "\n

User IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy_ids", + "full_name": "location[smart_proxy_ids]", + "description": "\n

Smart proxy IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_ids", + "full_name": "location[compute_resource_ids]", + "description": "\n

Compute resource IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_ids", + "full_name": "location[medium_ids]", + "description": "\n

Medium IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_ids", + "full_name": "location[config_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_ids", + "full_name": "location[ptable_ids]", + "description": "\n

Partition template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_ids", + "full_name": "location[provisioning_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_ids", + "full_name": "location[domain_ids]", + "description": "\n

Domain IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_ids", + "full_name": "location[realm_ids]", + "description": "\n

Realm IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "location[hostgroup_ids]", + "description": "\n

Host group IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "location[environment_ids]", + "description": "\n

Environment IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_ids", + "full_name": "location[subnet_ids]", + "description": "\n

Subnet IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parent_id", + "full_name": "location[parent_id]", + "description": "\n

Parent ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignore_types", + "full_name": "location[ignore_types]", + "description": "\n

List of resources types that will be automatically associated

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "location[organization_ids]", + "description": "\n

Associated organization IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/locations/update", + "name": "update", + "apis": [ + { + "api_url": "/api/locations/:id", + "http_method": "PUT", + "short_description": "Update a location", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location", + "full_name": "location", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "location[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "location[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_ids", + "full_name": "location[user_ids]", + "description": "\n

User IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy_ids", + "full_name": "location[smart_proxy_ids]", + "description": "\n

Smart proxy IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_ids", + "full_name": "location[compute_resource_ids]", + "description": "\n

Compute resource IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_ids", + "full_name": "location[medium_ids]", + "description": "\n

Medium IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_ids", + "full_name": "location[config_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_ids", + "full_name": "location[ptable_ids]", + "description": "\n

Partition template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_ids", + "full_name": "location[provisioning_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_ids", + "full_name": "location[domain_ids]", + "description": "\n

Domain IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_ids", + "full_name": "location[realm_ids]", + "description": "\n

Realm IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "location[hostgroup_ids]", + "description": "\n

Host group IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "location[environment_ids]", + "description": "\n

Environment IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_ids", + "full_name": "location[subnet_ids]", + "description": "\n

Subnet IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parent_id", + "full_name": "location[parent_id]", + "description": "\n

Parent ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignore_types", + "full_name": "location[ignore_types]", + "description": "\n

List of resources types that will be automatically associated

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "location[organization_ids]", + "description": "\n

Associated organization IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/locations/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/locations/:id", + "http_method": "DELETE", + "short_description": "Delete a location", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "usergroups": { + "doc_url": "../apidoc/v2/usergroups", + "api_url": "/api", + "name": "Usergroups", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/usergroups/index", + "name": "index", + "apis": [ + { + "api_url": "/api/usergroups", + "http_method": "GET", + "short_description": "List all user groups", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + }, + { + "name": "role", + "type": "string" + }, + { + "name": "role_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/usergroups/show", + "name": "show", + "apis": [ + { + "api_url": "/api/usergroups/:id", + "http_method": "GET", + "short_description": "Show a user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/usergroups/create", + "name": "create", + "apis": [ + { + "api_url": "/api/usergroups", + "http_method": "POST", + "short_description": "Create a user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup", + "full_name": "usergroup", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "usergroup[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "admin", + "full_name": "usergroup[admin]", + "description": "\n

is an admin user group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_ids", + "full_name": "usergroup[user_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_ids", + "full_name": "usergroup[usergroup_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role_ids", + "full_name": "usergroup[role_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/usergroups/update", + "name": "update", + "apis": [ + { + "api_url": "/api/usergroups/:id", + "http_method": "PUT", + "short_description": "Update a user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

User groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup", + "full_name": "usergroup", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "usergroup[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "admin", + "full_name": "usergroup[admin]", + "description": "\n

is an admin user group

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_ids", + "full_name": "usergroup[user_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_ids", + "full_name": "usergroup[usergroup_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role_ids", + "full_name": "usergroup[role_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/usergroups/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/usergroups/:id", + "http_method": "DELETE", + "short_description": "Delete a user group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "mail_notifications": { + "doc_url": "../apidoc/v2/mail_notifications", + "api_url": "/api", + "name": "Mail notifications", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/mail_notifications/index", + "name": "index", + "apis": [ + { + "api_url": "/api/mail_notifications", + "http_method": "GET", + "short_description": "List of email notifications", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "description", + "type": "text" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "user", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/mail_notifications/show", + "name": "show", + "apis": [ + { + "api_url": "/api/mail_notifications/:id", + "http_method": "GET", + "short_description": "Show an email notification", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Numerical ID or email notification name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "media": { + "doc_url": "../apidoc/v2/media", + "api_url": "/api", + "name": "Media", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/media/index", + "name": "index", + "apis": [ + { + "api_url": "/api/media", + "http_method": "GET", + "short_description": "List all installation media", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/media", + "http_method": "GET", + "short_description": "List all media for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/media", + "http_method": "GET", + "short_description": "List all media per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/media", + "http_method": "GET", + "short_description": "List all media per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "family", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "path", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/media/show", + "name": "show", + "apis": [ + { + "api_url": "/api/media/:id", + "http_method": "GET", + "short_description": "Show a medium", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/media/create", + "name": "create", + "apis": [ + { + "api_url": "/api/media", + "http_method": "POST", + "short_description": "Create a medium", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium", + "full_name": "medium", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "medium[name]", + "description": "\n

Name of media

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "path", + "full_name": "medium[path]", + "description": "\n

The path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).

\n\n

for example mirror.centos.org/centos/$version/os/$arch\nwhere $arch will be substituted for the host's actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.

\n\n

Solaris and Debian media may also use $release.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_family", + "full_name": "medium[os_family]", + "description": "\n

Operating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "medium[operatingsystem_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "medium[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "medium[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/media/update", + "name": "update", + "apis": [ + { + "api_url": "/api/media/:id", + "http_method": "PUT", + "short_description": "Update a medium", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium", + "full_name": "medium", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "medium[name]", + "description": "\n

Name of media

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "path", + "full_name": "medium[path]", + "description": "\n

The path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).

\n\n

for example mirror.centos.org/centos/$version/os/$arch\nwhere $arch will be substituted for the host's actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.

\n\n

Solaris and Debian media may also use $release.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_family", + "full_name": "medium[os_family]", + "description": "\n

Operating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "medium[operatingsystem_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "medium[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "medium[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/media/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/media/:id", + "http_method": "DELETE", + "short_description": "Delete a medium", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "models": { + "doc_url": "../apidoc/v2/models", + "api_url": "/api", + "name": "Models", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/models/index", + "name": "index", + "apis": [ + { + "api_url": "/api/models", + "http_method": "GET", + "short_description": "List all hardware models", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "hardware_model", + "type": "string" + }, + { + "name": "info", + "type": "text" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "vendor_class", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/models/show", + "name": "show", + "apis": [ + { + "api_url": "/api/models/:id", + "http_method": "GET", + "short_description": "Show a hardware model", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/models/create", + "name": "create", + "apis": [ + { + "api_url": "/api/models", + "http_method": "POST", + "short_description": "Create a hardware model", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "model", + "full_name": "model", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "model[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "info", + "full_name": "model[info]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "vendor_class", + "full_name": "model[vendor_class]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hardware_model", + "full_name": "model[hardware_model]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/models/update", + "name": "update", + "apis": [ + { + "api_url": "/api/models/:id", + "http_method": "PUT", + "short_description": "Update a hardware model", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "model", + "full_name": "model", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "model[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "info", + "full_name": "model[info]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "vendor_class", + "full_name": "model[vendor_class]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hardware_model", + "full_name": "model[hardware_model]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/models/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/models/:id", + "http_method": "DELETE", + "short_description": "Delete a hardware model", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "users": { + "doc_url": "../apidoc/v2/users", + "api_url": "/api", + "name": "Users", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/users/index", + "name": "index", + "apis": [ + { + "api_url": "/api/users", + "http_method": "GET", + "short_description": "List all users", + "deprecated": null + }, + { + "api_url": "/api/auth_source_ldaps/:auth_source_ldap_id/users", + "http_method": "GET", + "short_description": "List all users for LDAP authentication source", + "deprecated": null + }, + { + "api_url": "/api/auth_source_externals/:auth_source_external_id/users", + "http_method": "GET", + "short_description": "List all users for external authentication source", + "deprecated": null + }, + { + "api_url": "/api/usergroups/:usergroup_id/users", + "http_method": "GET", + "short_description": "List all users for user group", + "deprecated": null + }, + { + "api_url": "/api/roles/:role_id/users", + "http_method": "GET", + "short_description": "List all users for role", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/users", + "http_method": "GET", + "short_description": "List all users for location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/users", + "http_method": "GET", + "short_description": "List all users for organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "auth_source_ldap_id", + "full_name": "auth_source_ldap_id", + "description": "\n

ID of LDAP authentication source

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "usergroup_id", + "full_name": "usergroup_id", + "description": "\n

ID of user group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role_id", + "full_name": "role_id", + "description": "\n

ID of role

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "admin", + "values": [ + "true", + "false" + ] + }, + { + "name": "description", + "type": "text" + }, + { + "name": "firstname", + "type": "string" + }, + { + "name": "last_login_on", + "type": "datetime" + }, + { + "name": "lastname", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "login", + "type": "string" + }, + { + "name": "mail", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "role", + "type": "string" + }, + { + "name": "role_id", + "type": "integer" + }, + { + "name": "usergroup", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/users/show", + "name": "show", + "apis": [ + { + "api_url": "/api/users/:id", + "http_method": "GET", + "short_description": "Show a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/users/show_current", + "name": "show_current", + "apis": [ + { + "api_url": "/api/current_user", + "http_method": "GET", + "short_description": "Show the currently logged-in user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/users/create", + "name": "create", + "apis": [ + { + "api_url": "/api/users", + "http_method": "POST", + "short_description": "Create a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Adds role 'Default role' to the user by default

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user", + "full_name": "user", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "login", + "full_name": "user[login]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "firstname", + "full_name": "user[firstname]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lastname", + "full_name": "user[lastname]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mail", + "full_name": "user[mail]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "user[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "admin", + "full_name": "user[admin]", + "description": "\n

is an admin account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "user[password]", + "description": "\n

Required unless user is in an external authentication source

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_location_id", + "full_name": "user[default_location_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_organization_id", + "full_name": "user[default_organization_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_id", + "full_name": "user[auth_source_id]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "timezone", + "full_name": "user[timezone]", + "description": "\n

User's timezone

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Chihuahua, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Greenland, Montevideo, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Volgograd, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locale", + "full_name": "user[locale]", + "description": "\n

User's preferred locale

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: ca, de, en, en_GB, es, fr, gl, it, ja, ko, pl, pt_BR, ru, sv_SE, zh_CN, zh_TW, nl_NL, cs_CZ.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role_ids", + "full_name": "user[role_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "user[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "user[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/users/update", + "name": "update", + "apis": [ + { + "api_url": "/api/users/:id", + "http_method": "PUT", + "short_description": "Update a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Adds role 'Default role' to the user if it is not already present.\nOnly another admin can change the admin account attribute.

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user", + "full_name": "user", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "login", + "full_name": "user[login]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "firstname", + "full_name": "user[firstname]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lastname", + "full_name": "user[lastname]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mail", + "full_name": "user[mail]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "user[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "admin", + "full_name": "user[admin]", + "description": "\n

is an admin account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "user[password]", + "description": "\n

Required unless user is in an external authentication source

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_location_id", + "full_name": "user[default_location_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_organization_id", + "full_name": "user[default_organization_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_id", + "full_name": "user[auth_source_id]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "timezone", + "full_name": "user[timezone]", + "description": "\n

User's timezone

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Chihuahua, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Greenland, Montevideo, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Volgograd, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locale", + "full_name": "user[locale]", + "description": "\n

User's preferred locale

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: ca, de, en, en_GB, es, fr, gl, it, ja, ko, pl, pt_BR, ru, sv_SE, zh_CN, zh_TW, nl_NL, cs_CZ.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role_ids", + "full_name": "user[role_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "user[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "user[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "current_password", + "full_name": "user[current_password]", + "description": "\n

Required when user want to change own password

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/users/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/users/:id", + "http_method": "DELETE", + "short_description": "Delete a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "operatingsystems": { + "doc_url": "../apidoc/v2/operatingsystems", + "api_url": "/api", + "name": "Operating systems", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/operatingsystems/index", + "name": "index", + "apis": [ + { + "api_url": "/api/operatingsystems", + "http_method": "GET", + "short_description": "List all operating systems", + "deprecated": null + }, + { + "api_url": "/api/architectures/:architecture_id/operatingsystems", + "http_method": "GET", + "short_description": "List all operating systems for nested architecture", + "deprecated": null + }, + { + "api_url": "/api/media/:medium_id/operatingsystems", + "http_method": "GET", + "short_description": "List all operating systems for nested medium", + "deprecated": null + }, + { + "api_url": "/api/ptables/:ptable_id/operatingsystems", + "http_method": "GET", + "short_description": "List all operating systems for nested partition table", + "deprecated": null + }, + { + "api_url": "/api/config_templates/:config_template_id/operatingsystems", + "http_method": "GET", + "short_description": "List all operating systems for nested provisioning template", + "deprecated": null + }, + { + "api_url": "/api/provisioning_templates/:provisioning_template_id/operatingsystems", + "http_method": "GET", + "short_description": "List all operating systems for nested provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "architecture_id", + "description": "\n

ID of architecture

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_id", + "full_name": "medium_id", + "description": "\n

ID of medium

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_id", + "full_name": "ptable_id", + "description": "\n

ID of partition table

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "config_template_id", + "description": "\n

ID of template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "provisioning_template_id", + "description": "\n

ID of template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_parameters_attributes", + "full_name": "os_parameters_attributes", + "description": "\n

Array of parameters

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "os_parameters_attributes[name]", + "description": "\n

Name of the parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "os_parameters_attributes[value]", + "description": "\n

Parameter value

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "architecture", + "type": "string" + }, + { + "name": "description", + "type": "string" + }, + { + "name": "family", + "type": "string" + }, + { + "name": "major", + "type": "string" + }, + { + "name": "medium", + "type": "string" + }, + { + "name": "minor", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "params", + "type": "text" + }, + { + "name": "template", + "type": "string" + }, + { + "name": "title", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/operatingsystems/show", + "name": "show", + "apis": [ + { + "api_url": "/api/operatingsystems/:id", + "http_method": "GET", + "short_description": "Show an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden_parameters", + "full_name": "show_hidden_parameters", + "description": "\n

Display hidden parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/operatingsystems/create", + "name": "create", + "apis": [ + { + "api_url": "/api/operatingsystems", + "http_method": "POST", + "short_description": "Create an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem", + "full_name": "operatingsystem", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "operatingsystem[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must match regular expression /\\A(\\S+)\\Z/.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "major", + "full_name": "operatingsystem[major]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "minor", + "full_name": "operatingsystem[minor]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "operatingsystem[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "family", + "full_name": "operatingsystem[family]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "release_name", + "full_name": "operatingsystem[release_name]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_parameters_attributes", + "full_name": "operatingsystem[os_parameters_attributes]", + "description": "\n

Array of parameters

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "operatingsystem[os_parameters_attributes][name]", + "description": "\n

Name of the parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "operatingsystem[os_parameters_attributes][value]", + "description": "\n

Parameter value

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "password_hash", + "full_name": "operatingsystem[password_hash]", + "description": "\n

Root password hash function to use

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: SHA256, SHA512, Base64, Base64-Windows, MD5.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_ids", + "full_name": "operatingsystem[architecture_ids]", + "description": "\n

IDs of associated architectures

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_ids", + "full_name": "operatingsystem[config_template_ids]", + "description": "\n

IDs of associated provisioning templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_ids", + "full_name": "operatingsystem[provisioning_template_ids]", + "description": "\n

IDs of associated provisioning templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_ids", + "full_name": "operatingsystem[medium_ids]", + "description": "\n

IDs of associated media

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_ids", + "full_name": "operatingsystem[ptable_ids]", + "description": "\n

IDs of associated partition tables

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/operatingsystems/update", + "name": "update", + "apis": [ + { + "api_url": "/api/operatingsystems/:id", + "http_method": "PUT", + "short_description": "Update an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem", + "full_name": "operatingsystem", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "operatingsystem[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must match regular expression /\\A(\\S+)\\Z/.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "major", + "full_name": "operatingsystem[major]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "minor", + "full_name": "operatingsystem[minor]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "operatingsystem[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "family", + "full_name": "operatingsystem[family]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "release_name", + "full_name": "operatingsystem[release_name]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_parameters_attributes", + "full_name": "operatingsystem[os_parameters_attributes]", + "description": "\n

Array of parameters

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "operatingsystem[os_parameters_attributes][name]", + "description": "\n

Name of the parameter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "operatingsystem[os_parameters_attributes][value]", + "description": "\n

Parameter value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "password_hash", + "full_name": "operatingsystem[password_hash]", + "description": "\n

Root password hash function to use

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: SHA256, SHA512, Base64, Base64-Windows, MD5.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_ids", + "full_name": "operatingsystem[architecture_ids]", + "description": "\n

IDs of associated architectures

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_ids", + "full_name": "operatingsystem[config_template_ids]", + "description": "\n

IDs of associated provisioning templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_ids", + "full_name": "operatingsystem[provisioning_template_ids]", + "description": "\n

IDs of associated provisioning templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_ids", + "full_name": "operatingsystem[medium_ids]", + "description": "\n

IDs of associated media

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_ids", + "full_name": "operatingsystem[ptable_ids]", + "description": "\n

IDs of associated partition tables

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/operatingsystems/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/operatingsystems/:id", + "http_method": "DELETE", + "short_description": "Delete an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/operatingsystems/bootfiles", + "name": "bootfiles", + "apis": [ + { + "api_url": "/api/operatingsystems/:id/bootfiles", + "http_method": "GET", + "short_description": "List boot files for an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium", + "full_name": "medium", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture", + "full_name": "architecture", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "organizations": { + "doc_url": "../apidoc/v2/organizations", + "api_url": "/api", + "name": "Organizations", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/organizations/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/organizations", + "http_method": "GET", + "short_description": "List all organizations", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "description", + "type": "text" + }, + { + "name": "id", + "type": "integer" + }, + { + "name": "label", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "title", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/organizations/:id", + "http_method": "GET", + "short_description": "Show organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/organizations", + "http_method": "POST", + "short_description": "Create organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization", + "full_name": "organization", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "organization[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "organization[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_ids", + "full_name": "organization[user_ids]", + "description": "\n

User IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy_ids", + "full_name": "organization[smart_proxy_ids]", + "description": "\n

Smart proxy IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_ids", + "full_name": "organization[compute_resource_ids]", + "description": "\n

Compute resource IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_ids", + "full_name": "organization[medium_ids]", + "description": "\n

Medium IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_ids", + "full_name": "organization[config_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_ids", + "full_name": "organization[ptable_ids]", + "description": "\n

Partition template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_ids", + "full_name": "organization[provisioning_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_ids", + "full_name": "organization[domain_ids]", + "description": "\n

Domain IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_ids", + "full_name": "organization[realm_ids]", + "description": "\n

Realm IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "organization[hostgroup_ids]", + "description": "\n

Host group IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "organization[environment_ids]", + "description": "\n

Environment IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_ids", + "full_name": "organization[subnet_ids]", + "description": "\n

Subnet IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "organization[label]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/organizations/:id", + "http_method": "PUT", + "short_description": "Update organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "redhat_repository_url", + "full_name": "redhat_repository_url", + "description": "\n

Red Hat CDN URL

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization", + "full_name": "organization", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "organization[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "organization[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_ids", + "full_name": "organization[user_ids]", + "description": "\n

User IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_proxy_ids", + "full_name": "organization[smart_proxy_ids]", + "description": "\n

Smart proxy IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "compute_resource_ids", + "full_name": "organization[compute_resource_ids]", + "description": "\n

Compute resource IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_ids", + "full_name": "organization[medium_ids]", + "description": "\n

Medium IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_ids", + "full_name": "organization[config_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_ids", + "full_name": "organization[ptable_ids]", + "description": "\n

Partition template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_ids", + "full_name": "organization[provisioning_template_ids]", + "description": "\n

Provisioning template IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_ids", + "full_name": "organization[domain_ids]", + "description": "\n

Domain IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "realm_ids", + "full_name": "organization[realm_ids]", + "description": "\n

Realm IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "organization[hostgroup_ids]", + "description": "\n

Host group IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "organization[environment_ids]", + "description": "\n

Environment IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_ids", + "full_name": "organization[subnet_ids]", + "description": "\n

Subnet IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parent_id", + "full_name": "organization[parent_id]", + "description": "\n

Parent ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignore_types", + "full_name": "organization[ignore_types]", + "description": "\n

List of resources types that will be automatically associated

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "organization[location_ids]", + "description": "\n

Associated location IDs

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/organizations/:id", + "http_method": "DELETE", + "short_description": "Delete an organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/repo_discover", + "name": "repo_discover", + "apis": [ + { + "api_url": "/katello/api/organizations/:id/repo_discover", + "http_method": "PUT", + "short_description": "Discover Repositories", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "url", + "description": "\n

Base URL to perform repo discovery on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

One of yum or docker

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upstream_username", + "full_name": "upstream_username", + "description": "\n

Username to access URL

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upstream_password", + "full_name": "upstream_password", + "description": "\n

Password to access URL

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search pattern (defaults to '*')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/cancel_repo_discover", + "name": "cancel_repo_discover", + "apis": [ + { + "api_url": "/katello/api/organizations/:label/cancel_repo_discover", + "http_method": "PUT", + "short_description": "Cancel repository discovery", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "\n

Organization label

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "url", + "description": "\n

base url to perform repo discovery on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/download_debug_certificate", + "name": "download_debug_certificate", + "apis": [ + { + "api_url": "/katello/api/organizations/:label/download_debug_certificate", + "http_method": "GET", + "short_description": "Download a debug certificate", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "\n

Organization label

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/releases", + "name": "releases", + "apis": [ + { + "api_url": "/katello/api/organizations/:id/releases", + "http_method": "GET", + "short_description": "List available releases in the organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the Organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/autoattach_subscriptions", + "name": "autoattach_subscriptions", + "apis": [ + { + "api_url": "/katello/api/organizations/:id/autoattach_subscriptions", + "http_method": "POST", + "short_description": "Auto-attach available subscriptions to all hosts within an organization. Asynchronous operation.", + "deprecated": true + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/organizations/redhat_provider", + "name": "redhat_provider", + "apis": [ + { + "api_url": "/katello/api/organizations/:id/redhat_provider", + "http_method": "GET", + "short_description": "List all :resource_id", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "auth_source_externals": { + "doc_url": "../apidoc/v2/auth_source_externals", + "api_url": "/api", + "name": "Auth source externals", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/auth_source_externals/index", + "name": "index", + "apis": [ + { + "api_url": "/api/auth_source_externals", + "http_method": "GET", + "short_description": "List external authentication sources", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/auth_source_externals", + "http_method": "GET", + "short_description": "List external authentication sources per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/auth_source_externals", + "http_method": "GET", + "short_description": "List external authentication sources per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_externals/show", + "name": "show", + "apis": [ + { + "api_url": "/api/auth_source_externals/:id", + "http_method": "GET", + "short_description": "Show an external authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_externals/update", + "name": "update", + "apis": [ + { + "api_url": "/api/auth_source_externals/:id", + "http_method": "PUT", + "short_description": "Update an external authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auth_source_external", + "full_name": "auth_source_external", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "auth_source_external[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "auth_source_external[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "auth_source_external[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "os_default_templates": { + "doc_url": "../apidoc/v2/os_default_templates", + "api_url": "/api", + "name": "Os default templates", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/os_default_templates/index", + "name": "index", + "apis": [ + { + "api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates", + "http_method": "GET", + "short_description": "List default templates combinations for an operating system", + "deprecated": null + }, + { + "api_url": "/api/config_templates/:config_template_id/os_default_templates", + "http_method": "GET", + "short_description": "List operating systems where this template is set as a default", + "deprecated": null + }, + { + "api_url": "/api/provisioning_templates/:provisioning_template_id/os_default_templates", + "http_method": "GET", + "short_description": "List operating systems where this template is set as a default", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "config_template_id", + "description": "\n

ID of provisioning template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "provisioning_template_id", + "description": "\n

ID of provisioning template

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/os_default_templates/show", + "name": "show", + "apis": [ + { + "api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id", + "http_method": "GET", + "short_description": "Show a default template combination for an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/os_default_templates/create", + "name": "create", + "apis": [ + { + "api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates", + "http_method": "POST", + "short_description": "Create a default template combination for an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_default_template", + "full_name": "os_default_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "template_kind_id", + "full_name": "os_default_template[template_kind_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "os_default_template[config_template_id]", + "description": "\n

ID of provisioning template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "os_default_template[provisioning_template_id]", + "description": "\n

ID of provisioning template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/os_default_templates/update", + "name": "update", + "apis": [ + { + "api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id", + "http_method": "PUT", + "short_description": "Update a default template combination for an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_default_template", + "full_name": "os_default_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "template_kind_id", + "full_name": "os_default_template[template_kind_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "config_template_id", + "full_name": "os_default_template[config_template_id]", + "description": "\n

ID of provisioning template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template_id", + "full_name": "os_default_template[provisioning_template_id]", + "description": "\n

ID of provisioning template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/os_default_templates/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id", + "http_method": "DELETE", + "short_description": "Delete a default template combination for an operating system", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "auth_source_internals": { + "doc_url": "../apidoc/v2/auth_source_internals", + "api_url": "/api", + "name": "Auth source internals", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/auth_source_internals/index", + "name": "index", + "apis": [ + { + "api_url": "/api/auth_source_internals", + "http_method": "GET", + "short_description": "List internal authentication sources", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/auth_source_internals/show", + "name": "show", + "apis": [ + { + "api_url": "/api/auth_source_internals/:id", + "http_method": "GET", + "short_description": "Show an internal authentication source", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "override_values": { + "doc_url": "../apidoc/v2/override_values", + "api_url": "/api", + "name": "Override values", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/override_values/index", + "name": "index", + "apis": [ + { + "api_url": "/api/smart_variables/:smart_variable_id/override_values", + "http_method": "GET", + "short_description": "List of override values for a specific smart variable", + "deprecated": null + }, + { + "api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values", + "http_method": "GET", + "short_description": "List of override values for a specific smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable_id", + "full_name": "smart_variable_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_class_parameter_id", + "full_name": "smart_class_parameter_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/override_values/show", + "name": "show", + "apis": [ + { + "api_url": "/api/smart_variables/:smart_variable_id/override_values/:id", + "http_method": "GET", + "short_description": "Show an override value for a specific smart variable", + "deprecated": null + }, + { + "api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id", + "http_method": "GET", + "short_description": "Show an override value for a specific smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable_id", + "full_name": "smart_variable_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_class_parameter_id", + "full_name": "smart_class_parameter_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/override_values/create", + "name": "create", + "apis": [ + { + "api_url": "/api/smart_variables/:smart_variable_id/override_values", + "http_method": "POST", + "short_description": "Create an override value for a specific smart variable", + "deprecated": null + }, + { + "api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values", + "http_method": "POST", + "short_description": "Create an override value for a specific smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable_id", + "full_name": "smart_variable_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_class_parameter_id", + "full_name": "smart_class_parameter_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value", + "full_name": "override_value", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "match", + "full_name": "override_value[match]", + "description": "\n

Override match

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "override_value[value]", + "description": "\n

Override value, required if omit is false

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_puppet_default", + "full_name": "override_value[use_puppet_default]", + "description": "\n

Deprecated, please use omit

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "omit", + "full_name": "override_value[omit]", + "description": "\n

foreman will not send this parameter in classification output, replaces\nuse_puppet_default

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/override_values/update", + "name": "update", + "apis": [ + { + "api_url": "/api/smart_variables/:smart_variable_id/override_values/:id", + "http_method": "PUT", + "short_description": "Update an override value for a specific smart variable", + "deprecated": null + }, + { + "api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id", + "http_method": "PUT", + "short_description": "Update an override value for a specific smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable_id", + "full_name": "smart_variable_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_class_parameter_id", + "full_name": "smart_class_parameter_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value", + "full_name": "override_value", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "match", + "full_name": "override_value[match]", + "description": "\n

Override match

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "override_value[value]", + "description": "\n

Override value, required if omit is false

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_puppet_default", + "full_name": "override_value[use_puppet_default]", + "description": "\n

Deprecated, please use omit

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "omit", + "full_name": "override_value[omit]", + "description": "\n

foreman will not send this parameter in classification output, replaces\nuse_puppet_default

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/override_values/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/smart_variables/:smart_variable_id/override_values/:id", + "http_method": "DELETE", + "short_description": "Delete an override value for a specific smart variable", + "deprecated": null + }, + { + "api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id", + "http_method": "DELETE", + "short_description": "Delete an override value for a specific smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable_id", + "full_name": "smart_variable_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_class_parameter_id", + "full_name": "smart_class_parameter_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "parameters": { + "doc_url": "../apidoc/v2/parameters", + "api_url": "/api", + "name": "Parameters", + "short_description": null, + "full_description": "\n

These API calls are related to nested parameters for a host,\ndomain, subnet, host group, operating system. If you are looking\nfor <a href=\u201ccommon_parameters.html\u201d>global parameters</a>, go\nto <a href=\u201ccommon_parameters.html\u201d>this link</a>.

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/parameters/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for a host group", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for a domain", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for a location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for an organization", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/parameters", + "http_method": "GET", + "short_description": "List all parameters for a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "domain_name", + "type": "string" + }, + { + "name": "host_group_name", + "type": "string" + }, + { + "name": "host_name", + "type": "string" + }, + { + "name": "key_type", + "type": "string" + }, + { + "name": "location_name", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_name", + "type": "string" + }, + { + "name": "os_name", + "type": "string" + }, + { + "name": "parameter_type", + "type": "string" + }, + { + "name": "subnet_name", + "type": "text" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "value", + "type": "text" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/parameters/show", + "name": "show", + "apis": [ + { + "api_url": "/api/hosts/:host_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for a host group", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for a domain", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for a location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for an organization", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/parameters/:id", + "http_method": "GET", + "short_description": "Show a nested parameter for a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/parameters/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hosts/:host_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for a host group", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for a domain", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for a location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for an organization", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/parameters", + "http_method": "POST", + "short_description": "Create a nested parameter for a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter", + "full_name": "parameter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "parameter[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "parameter[value]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "parameter[parameter_type]", + "description": "\n

Type of value

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/parameters/update", + "name": "update", + "apis": [ + { + "api_url": "/api/hosts/:host_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for a host group", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for a domain", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for a location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for an organization", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/parameters/:id", + "http_method": "PUT", + "short_description": "Update a nested parameter for a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter", + "full_name": "parameter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "parameter[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "parameter[value]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "parameter[parameter_type]", + "description": "\n

Type of value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/parameters/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hosts/:host_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for a host group", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for a domain", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for a location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for an organization", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/parameters/:id", + "http_method": "DELETE", + "short_description": "Delete a nested parameter for a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of parameter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/parameters/reset", + "name": "reset", + "apis": [ + { + "api_url": "/api/hosts/:host_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameters for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameters for a host group", + "deprecated": null + }, + { + "api_url": "/api/domains/:domain_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameters for a domain", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameters for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameter for a location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameter for an organization", + "deprecated": null + }, + { + "api_url": "/api/subnets/:subnet_id/parameters", + "http_method": "DELETE", + "short_description": "Delete all nested parameters for a subnet", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "domain_id", + "description": "\n

ID of domain

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

ID of location

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "\n

ID of subnet

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "permissions": { + "doc_url": "../apidoc/v2/permissions", + "api_url": "/api", + "name": "Permissions", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/permissions/index", + "name": "index", + "apis": [ + { + "api_url": "/api/permissions", + "http_method": "GET", + "short_description": "List all permissions", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "resource_type", + "full_name": "resource_type", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + }, + { + "name": "resource_type", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/permissions/show", + "name": "show", + "apis": [ + { + "api_url": "/api/permissions/:id", + "http_method": "GET", + "short_description": "Show a permission", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/permissions/resource_types", + "name": "resource_types", + "apis": [ + { + "api_url": "/api/permissions/resource_types", + "http_method": "GET", + "short_description": "List available resource types", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "plugins": { + "doc_url": "../apidoc/v2/plugins", + "api_url": "/api", + "name": "Plugins", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/plugins/index", + "name": "index", + "apis": [ + { + "api_url": "/api/plugins", + "http_method": "GET", + "short_description": "List installed plugins", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "puppetclasses": { + "doc_url": "../apidoc/v2/puppetclasses", + "api_url": "/api", + "name": "Puppetclasses", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/puppetclasses/index", + "name": "index", + "apis": [ + { + "api_url": "/api/puppetclasses", + "http_method": "GET", + "short_description": "List all Puppet classes", + "deprecated": null + }, + { + "api_url": "/api/hosts/:host_id/puppetclasses", + "http_method": "GET", + "short_description": "List all Puppet classes for a host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/puppetclasses", + "http_method": "GET", + "short_description": "List all Puppet classes for a host group", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/puppetclasses", + "http_method": "GET", + "short_description": "List all Puppet classes for an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "config_group", + "type": "string" + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "host", + "type": "string" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/puppetclasses/show", + "name": "show", + "apis": [ + { + "api_url": "/api/puppetclasses/:id", + "http_method": "GET", + "short_description": "Show a Puppet class", + "deprecated": null + }, + { + "api_url": "/api/hosts/:host_id/puppetclasses/:id", + "http_method": "GET", + "short_description": "Show a Puppet class for host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/puppetclasses/:id", + "http_method": "GET", + "short_description": "Show a Puppet class for a host group", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/puppetclasses/:id", + "http_method": "GET", + "short_description": "Show a Puppet class for an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "\n

ID of host group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of Puppet class

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/puppetclasses/create", + "name": "create", + "apis": [ + { + "api_url": "/api/puppetclasses", + "http_method": "POST", + "short_description": "Create a Puppet class", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass", + "full_name": "puppetclass", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "puppetclass[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/puppetclasses/update", + "name": "update", + "apis": [ + { + "api_url": "/api/puppetclasses/:id", + "http_method": "PUT", + "short_description": "Update a Puppet class", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass", + "full_name": "puppetclass", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "puppetclass[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/puppetclasses/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/puppetclasses/:id", + "http_method": "DELETE", + "short_description": "Delete a Puppet class", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "provisioning_templates": { + "doc_url": "../apidoc/v2/provisioning_templates", + "api_url": "/api", + "name": "Provisioning templates", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/provisioning_templates/index", + "name": "index", + "apis": [ + { + "api_url": "/api/provisioning_templates", + "http_method": "GET", + "short_description": "List provisioning templates", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/provisioning_templates", + "http_method": "GET", + "short_description": "List provisioning templates per operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/provisioning_templates", + "http_method": "GET", + "short_description": "List provisioning templates per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/provisioning_templates", + "http_method": "GET", + "short_description": "List provisioning templates per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "default_template", + "values": [ + "true", + "false" + ] + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "kind", + "type": "string" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "locked", + "values": [ + "true", + "false" + ] + }, + { + "name": "name", + "type": "string" + }, + { + "name": "operatingsystem", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "snippet", + "values": [ + "true", + "false" + ] + }, + { + "name": "template", + "type": "text" + }, + { + "name": "vendor", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/show", + "name": "show", + "apis": [ + { + "api_url": "/api/provisioning_templates/:id", + "http_method": "GET", + "short_description": "Show provisioning template details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/create", + "name": "create", + "apis": [ + { + "api_url": "/api/provisioning_templates", + "http_method": "POST", + "short_description": "Create a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template", + "full_name": "provisioning_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "provisioning_template[name]", + "description": "\n

template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "provisioning_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "provisioning_template[template]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "provisioning_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "provisioning_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_kind_id", + "full_name": "provisioning_template[template_kind_id]", + "description": "\n

not relevant for snippet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_combinations_attributes", + "full_name": "provisioning_template[template_combinations_attributes]", + "description": "\n

Array of template combinations (hostgroup_id, environment_id)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "provisioning_template[operatingsystem_ids]", + "description": "\n

Array of operating system IDs to associate with the template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "provisioning_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "provisioning_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "provisioning_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/import", + "name": "import", + "apis": [ + { + "api_url": "/api/provisioning_templates/import", + "http_method": "POST", + "short_description": "Import a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template", + "full_name": "provisioning_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "provisioning_template[name]", + "description": "\n

template name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "provisioning_template[template]", + "description": "\n

template contents including metadata

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "provisioning_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "provisioning_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "options", + "full_name": "options", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "force", + "full_name": "options[force]", + "description": "\n

use if you want update locked templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "associate", + "full_name": "options[associate]", + "description": "\n

determines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: new, always, never.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lock", + "full_name": "options[lock]", + "description": "\n

lock imported templates (false by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "options[default]", + "description": "\n

makes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/update", + "name": "update", + "apis": [ + { + "api_url": "/api/provisioning_templates/:id", + "http_method": "PUT", + "short_description": "Update a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template", + "full_name": "provisioning_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "provisioning_template[name]", + "description": "\n

template name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "provisioning_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "provisioning_template[template]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "provisioning_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "provisioning_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_kind_id", + "full_name": "provisioning_template[template_kind_id]", + "description": "\n

not relevant for snippet

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_combinations_attributes", + "full_name": "provisioning_template[template_combinations_attributes]", + "description": "\n

Array of template combinations (hostgroup_id, environment_id)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "provisioning_template[operatingsystem_ids]", + "description": "\n

Array of operating system IDs to associate with the template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "provisioning_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "provisioning_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "provisioning_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/revision", + "name": "revision", + "apis": [ + { + "api_url": "/api/provisioning_templates/revision", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

template version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/provisioning_templates/:id", + "http_method": "DELETE", + "short_description": "Delete a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/build_pxe_default", + "name": "build_pxe_default", + "apis": [ + { + "api_url": "/api/provisioning_templates/build_pxe_default", + "http_method": "POST", + "short_description": "Update the default PXE menu on all configured TFTP servers", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/provisioning_templates/:id/clone", + "http_method": "POST", + "short_description": "Clone a provision template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provisioning_template", + "full_name": "provisioning_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "provisioning_template[name]", + "description": "\n

template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/provisioning_templates/export", + "name": "export", + "apis": [ + { + "api_url": "/api/provisioning_templates/:id/export", + "http_method": "GET", + "short_description": "Export a provisioning template to ERB", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "ptables": { + "doc_url": "../apidoc/v2/ptables", + "api_url": "/api", + "name": "Ptables", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ptables/index", + "name": "index", + "apis": [ + { + "api_url": "/api/ptables", + "http_method": "GET", + "short_description": "List all partition tables", + "deprecated": null + }, + { + "api_url": "/api/operatingsystems/:operatingsystem_id/ptables", + "http_method": "GET", + "short_description": "List all partition tables for an operating system", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/ptables", + "http_method": "GET", + "short_description": "List all partition tables per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/ptables", + "http_method": "GET", + "short_description": "List all partition tables per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "operatingsystem_id", + "full_name": "operatingsystem_id", + "description": "\n

ID of operating system

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "default", + "values": [ + "true", + "false" + ] + }, + { + "name": "family", + "type": "string" + }, + { + "name": "layout", + "type": "text" + }, + { + "name": "location", + "type": "string" + }, + { + "name": "location_id", + "type": "integer" + }, + { + "name": "locked", + "values": [ + "true", + "false" + ] + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "snippet", + "values": [ + "true", + "false" + ] + }, + { + "name": "template", + "type": "text" + }, + { + "name": "vendor", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/show", + "name": "show", + "apis": [ + { + "api_url": "/api/ptables/:id", + "http_method": "GET", + "short_description": "Show a partition table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/create", + "name": "create", + "apis": [ + { + "api_url": "/api/ptables", + "http_method": "POST", + "short_description": "Create a partition table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable", + "full_name": "ptable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "ptable[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "ptable[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "layout", + "full_name": "ptable[layout]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "ptable[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "ptable[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "ptable[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_family", + "full_name": "ptable[os_family]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "ptable[operatingsystem_ids]", + "description": "\n

Array of operating system IDs to associate with the partition table

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "ptable[host_ids]", + "description": "\n

Array of host IDs to associate with the partition table

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "ptable[hostgroup_ids]", + "description": "\n

Array of host group IDs to associate with the partition table

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "ptable[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "ptable[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/import", + "name": "import", + "apis": [ + { + "api_url": "/api/ptables/import", + "http_method": "POST", + "short_description": "Import a provisioning template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable", + "full_name": "ptable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "ptable[name]", + "description": "\n

template name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "ptable[template]", + "description": "\n

template contents including metadata

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "ptable[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "ptable[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "options", + "full_name": "options", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "force", + "full_name": "options[force]", + "description": "\n

use if you want update locked templates

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "associate", + "full_name": "options[associate]", + "description": "\n

determines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: new, always, never.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lock", + "full_name": "options[lock]", + "description": "\n

lock imported templates (false by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default", + "full_name": "options[default]", + "description": "\n

makes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/revision", + "name": "revision", + "apis": [ + { + "api_url": "/api/ptables/revision", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

template version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/update", + "name": "update", + "apis": [ + { + "api_url": "/api/ptables/:id", + "http_method": "PUT", + "short_description": "Update a partition table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable", + "full_name": "ptable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "ptable[name]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "ptable[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "layout", + "full_name": "ptable[layout]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "ptable[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "ptable[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "ptable[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "os_family", + "full_name": "ptable[os_family]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_ids", + "full_name": "ptable[operatingsystem_ids]", + "description": "\n

Array of operating system IDs to associate with the partition table

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "ptable[host_ids]", + "description": "\n

Array of host IDs to associate with the partition table

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "ptable[hostgroup_ids]", + "description": "\n

Array of host group IDs to associate with the partition table

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "ptable[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "ptable[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/ptables/:id", + "http_method": "DELETE", + "short_description": "Delete a partition table", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/ptables/:id/clone", + "http_method": "POST", + "short_description": "Clone a template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable", + "full_name": "ptable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "ptable[name]", + "description": "\n

template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ptables/export", + "name": "export", + "apis": [ + { + "api_url": "/api/ptables/:id/export", + "http_method": "GET", + "short_description": "Export a partition template to ERB", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "smart_class_parameters": { + "doc_url": "../apidoc/v2/smart_class_parameters", + "api_url": "/api", + "name": "Smart class parameters", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/smart_class_parameters/index", + "name": "index", + "apis": [ + { + "api_url": "/api/smart_class_parameters", + "http_method": "GET", + "short_description": "List all smart class parameters", + "deprecated": null + }, + { + "api_url": "/api/hosts/:host_id/smart_class_parameters", + "http_method": "GET", + "short_description": "List of smart class parameters for a specific host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/smart_class_parameters", + "http_method": "GET", + "short_description": "List of smart class parameters for a specific host group", + "deprecated": null + }, + { + "api_url": "/api/puppetclasses/:puppetclass_id/smart_class_parameters", + "http_method": "GET", + "short_description": "List of smart class parameters for a specific Puppet class", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/smart_class_parameters", + "http_method": "GET", + "short_description": "List of smart class parameters for a specific environment", + "deprecated": null + }, + { + "api_url": "/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters", + "http_method": "GET", + "short_description": "List of smart class parameters for a specific environment/Puppet class combination", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_id", + "full_name": "puppetclass_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "avoid_duplicates", + "values": [ + "true", + "false" + ] + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "merge_default", + "values": [ + "true", + "false" + ] + }, + { + "name": "merge_overrides", + "values": [ + "true", + "false" + ] + }, + { + "name": "override", + "values": [ + "true", + "false" + ] + }, + { + "name": "parameter", + "type": "string" + }, + { + "name": "puppetclass", + "type": "string" + }, + { + "name": "puppetclass_name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_class_parameters/show", + "name": "show", + "apis": [ + { + "api_url": "/api/smart_class_parameters/:id", + "http_method": "GET", + "short_description": "Show a smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_class_parameters/update", + "name": "update", + "apis": [ + { + "api_url": "/api/smart_class_parameters/:id", + "http_method": "PUT", + "short_description": "Update a smart class parameter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_class_parameter", + "full_name": "smart_class_parameter", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "override", + "full_name": "smart_class_parameter[override]", + "description": "\n

Whether the smart class parameter value is managed by foreman

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "smart_class_parameter[description]", + "description": "\n

Description of smart class

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_value", + "full_name": "smart_class_parameter[default_value]", + "description": "\n

Value to use when there is no match

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "smart_class_parameter[hidden_value]", + "description": "\n

When enabled the parameter is hidden in the UI

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "use_puppet_default", + "full_name": "smart_class_parameter[use_puppet_default]", + "description": "\n

Deprecated, please use omit

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "omit", + "full_name": "smart_class_parameter[omit]", + "description": "\n

foreman will not send this parameter in classification output. Puppet\nwill use the value defined in the Puppet manifest for this parameter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "path", + "full_name": "smart_class_parameter[path]", + "description": "\n

The order in which values are resolved

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_type", + "full_name": "smart_class_parameter[validator_type]", + "description": "\n

Types of validation values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: regexp, list.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_rule", + "full_name": "smart_class_parameter[validator_rule]", + "description": "\n

Used to enforce certain values for the parameter values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value_order", + "full_name": "smart_class_parameter[override_value_order]", + "description": "\n

The order in which values are resolved

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "parameter_type", + "full_name": "smart_class_parameter[parameter_type]", + "description": "\n

Types of variable values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "required", + "full_name": "smart_class_parameter[required]", + "description": "\n

If true, will raise an error if there is no default value and no matcher\nprovide a value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_overrides", + "full_name": "smart_class_parameter[merge_overrides]", + "description": "\n

Merge all matching values (only array/hash type)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_default", + "full_name": "smart_class_parameter[merge_default]", + "description": "\n

Include default value when merging all matching values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "avoid_duplicates", + "full_name": "smart_class_parameter[avoid_duplicates]", + "description": "\n

Remove duplicate values (only array type)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "auth_sources": { + "doc_url": "../apidoc/v2/auth_sources", + "api_url": "/api", + "name": "Auth sources", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/auth_sources/index", + "name": "index", + "apis": [ + { + "api_url": "/api/auth_sources", + "http_method": "GET", + "short_description": "List all authentication sources", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/auth_sources", + "http_method": "GET", + "short_description": "List all authentication sources per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/auth_sources", + "http_method": "GET", + "short_description": "List all authentication sources per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "smart_variables": { + "doc_url": "../apidoc/v2/smart_variables", + "api_url": "/api", + "name": "Smart variables", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/smart_variables/index", + "name": "index", + "apis": [ + { + "api_url": "/api/smart_variables", + "http_method": "GET", + "short_description": "List all smart variables", + "deprecated": null + }, + { + "api_url": "/api/hosts/:host_id/smart_variables", + "http_method": "GET", + "short_description": "List of smart variables for a specific host", + "deprecated": null + }, + { + "api_url": "/api/hostgroups/:hostgroup_id/smart_variables", + "http_method": "GET", + "short_description": "List of smart variables for a specific host group", + "deprecated": null + }, + { + "api_url": "/api/puppetclasses/:puppetclass_id/smart_variables", + "http_method": "GET", + "short_description": "List of smart variables for a specific Puppet class", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "hostgroup_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_id", + "full_name": "puppetclass_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "avoid_duplicates", + "values": [ + "true", + "false" + ] + }, + { + "name": "key", + "type": "string" + }, + { + "name": "merge_default", + "values": [ + "true", + "false" + ] + }, + { + "name": "merge_overrides", + "values": [ + "true", + "false" + ] + }, + { + "name": "override", + "values": [ + "true", + "false" + ] + }, + { + "name": "parameter", + "type": "string" + }, + { + "name": "puppetclass", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_variables/show", + "name": "show", + "apis": [ + { + "api_url": "/api/smart_variables/:id", + "http_method": "GET", + "short_description": "Show a smart variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "show_hidden", + "full_name": "show_hidden", + "description": "\n

Display hidden values

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_variables/create", + "name": "create", + "apis": [ + { + "api_url": "/api/smart_variables", + "http_method": "POST", + "short_description": "Create a smart variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable", + "full_name": "smart_variable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "variable", + "full_name": "smart_variable[variable]", + "description": "\n

Name of variable

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_id", + "full_name": "smart_variable[puppetclass_id]", + "description": "\n

Puppet class ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_value", + "full_name": "smart_variable[default_value]", + "description": "\n

Default value of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "smart_variable[hidden_value]", + "description": "\n

When enabled the parameter is hidden in the UI

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value_order", + "full_name": "smart_variable[override_value_order]", + "description": "\n

The order in which values are resolved

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "smart_variable[description]", + "description": "\n

Description of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_type", + "full_name": "smart_variable[validator_type]", + "description": "\n

Types of validation values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: regexp, list.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_rule", + "full_name": "smart_variable[validator_rule]", + "description": "\n

Used to enforce certain values for the parameter values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "variable_type", + "full_name": "smart_variable[variable_type]", + "description": "\n

Types of variable values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_overrides", + "full_name": "smart_variable[merge_overrides]", + "description": "\n

Merge all matching values (only array/hash type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_default", + "full_name": "smart_variable[merge_default]", + "description": "\n

Include default value when merging all matching values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "avoid_duplicates", + "full_name": "smart_variable[avoid_duplicates]", + "description": "\n

Remove duplicate values (only array type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_variables/update", + "name": "update", + "apis": [ + { + "api_url": "/api/smart_variables/:id", + "http_method": "PUT", + "short_description": "Update a smart variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "smart_variable", + "full_name": "smart_variable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "variable", + "full_name": "smart_variable[variable]", + "description": "\n

Name of variable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppetclass_id", + "full_name": "smart_variable[puppetclass_id]", + "description": "\n

Puppet class ID

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_value", + "full_name": "smart_variable[default_value]", + "description": "\n

Default value of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "smart_variable[hidden_value]", + "description": "\n

When enabled the parameter is hidden in the UI

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value_order", + "full_name": "smart_variable[override_value_order]", + "description": "\n

The order in which values are resolved

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "smart_variable[description]", + "description": "\n

Description of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_type", + "full_name": "smart_variable[validator_type]", + "description": "\n

Types of validation values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: regexp, list.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_rule", + "full_name": "smart_variable[validator_rule]", + "description": "\n

Used to enforce certain values for the parameter values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "variable_type", + "full_name": "smart_variable[variable_type]", + "description": "\n

Types of variable values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_overrides", + "full_name": "smart_variable[merge_overrides]", + "description": "\n

Merge all matching values (only array/hash type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_default", + "full_name": "smart_variable[merge_default]", + "description": "\n

Include default value when merging all matching values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "avoid_duplicates", + "full_name": "smart_variable[avoid_duplicates]", + "description": "\n

Remove duplicate values (only array type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/smart_variables/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/smart_variables/:id", + "http_method": "DELETE", + "short_description": "Delete a smart variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "ssh_keys": { + "doc_url": "../apidoc/v2/ssh_keys", + "api_url": "/api", + "name": "Ssh keys", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ssh_keys/index", + "name": "index", + "apis": [ + { + "api_url": "/api/users/:user_id/ssh_keys", + "http_method": "GET", + "short_description": "List all SSH keys for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + }, + { + "name": "user_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ssh_keys/show", + "name": "show", + "apis": [ + { + "api_url": "/api/users/:user_id/ssh_keys/:id", + "http_method": "GET", + "short_description": "Show an SSH key from a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ssh_keys/create", + "name": "create", + "apis": [ + { + "api_url": "/api/users/:user_id/ssh_keys", + "http_method": "POST", + "short_description": "Add an SSH key for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssh_key", + "full_name": "ssh_key", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "ssh_key[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "key", + "full_name": "ssh_key[key]", + "description": "\n

Public SSH key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ssh_keys/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/users/:user_id/ssh_keys/:id", + "http_method": "DELETE", + "short_description": "Delete an SSH key for a user", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "user_id", + "description": "\n

ID of the user

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "recurring_logics": { + "doc_url": "../apidoc/v2/recurring_logics", + "api_url": "/api", + "name": "Recurring logics", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/recurring_logics/index", + "name": "index", + "apis": [ + { + "api_url": "/foreman_tasks/api/recurring_logics", + "http_method": "GET", + "short_description": "List recurring logics", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/recurring_logics/show", + "name": "show", + "apis": [ + { + "api_url": "/foreman_tasks/api/recurring_logics/:id", + "http_method": "GET", + "short_description": "Show recurring logic details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the recurring logic

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/recurring_logics/update", + "name": "update", + "apis": [ + { + "api_url": "/foreman_tasks/api/recurring_logics/:id", + "http_method": "PUT", + "short_description": "Update recurring logic", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the recurring logic

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "enabled", + "description": "\n

Whether the recurring logic is enabled or disabled.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/recurring_logics/cancel", + "name": "cancel", + "apis": [ + { + "api_url": "/foreman_tasks/api/recurring_logics/:id/cancel", + "http_method": "POST", + "short_description": "Cancel recurring logic", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the recurring logic

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "foreman_tasks": { + "doc_url": "../apidoc/v2/foreman_tasks", + "api_url": "/api", + "name": "Foreman tasks", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/foreman_tasks/summary", + "name": "summary", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/summary", + "http_method": "GET", + "short_description": "Show task summary", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/show", + "name": "show", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/:id", + "http_method": "GET", + "short_description": "Show task details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

UUID of the task

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/details", + "name": "details", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/:id/details", + "http_method": "GET", + "short_description": "Show task extended details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

UUID of the task

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/sub_tasks", + "name": "sub_tasks", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/:id/sub_tasks", + "http_method": "GET", + "short_description": "Show sub_tasks details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

UUID of the task

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/bulk_search", + "name": "bulk_search", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/bulk_search", + "http_method": "POST", + "short_description": "List dynflow tasks for uuids", + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

For every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.

\n", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "searches", + "full_name": "searches", + "description": "\n

List of uuids to fetch info about

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search_id", + "full_name": "searches[search_id]", + "description": "\n

Arbitraty value for client to identify the the request parts with results.\nIt's passed in the results to be able to pair the requests and\nresponses properly.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "searches[type]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: user, resource, task.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "task_id", + "full_name": "searches[task_id]", + "description": "\n

In case :type = 'task', find the task by the uuid

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_id", + "full_name": "searches[user_id]", + "description": "\n

In case :type = 'user', find tasks for the user

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "resource_type", + "full_name": "searches[resource_type]", + "description": "\n

In case :type = 'resource', what resource type we're searching\nthe tasks for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "resource_type", + "full_name": "searches[resource_type]", + "description": "\n

In case :type = 'resource', what resource id we're searching\nthe tasks for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "action_types", + "full_name": "searches[action_types]", + "description": "\n

Return just tasks of given action type, e.g.\n[\u201cActions::foreman::Repository::Synchronize\u201d]

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: String.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "active_only", + "full_name": "searches[active_only]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "searches[page]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "searches[per_page]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/bulk_resume", + "name": "bulk_resume", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/bulk_resume", + "http_method": "POST", + "short_description": "Resume all paused error tasks", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Resume tasks matching search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "task_ids", + "full_name": "task_ids", + "description": "\n

Resume specific tasks by ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/index", + "name": "index", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks", + "http_method": "GET", + "short_description": "List tasks", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, e.g. 'name DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort", + "full_name": "sort", + "description": "\n

Hash version of 'order' param

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "by", + "full_name": "sort[by]", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "sort[order]", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreman_tasks/callback", + "name": "callback", + "apis": [ + { + "api_url": "/foreman_tasks/api/tasks/callback", + "http_method": "POST", + "short_description": "Send data to the task from external executor (such as smart_proxy_dynflow)", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "callback", + "full_name": "callback", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "task_id", + "full_name": "callback[task_id]", + "description": "\n

UUID of the task

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "step_id", + "full_name": "callback[step_id]", + "description": "\n

The ID of the step inside the execution plan to send the event to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "data", + "full_name": "data", + "description": "\n

Data to be sent to the action

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "callbacks", + "full_name": "callbacks", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "callback", + "full_name": "callbacks[callback]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "task_id", + "full_name": "callbacks[callback][task_id]", + "description": "\n

UUID of the task

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "step_id", + "full_name": "callbacks[callback][step_id]", + "description": "\n

The ID of the step inside the execution plan to send the event to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "data", + "full_name": "callbacks[data]", + "description": "\n

Data to be sent to the action

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "foreign_input_sets": { + "doc_url": "../apidoc/v2/foreign_input_sets", + "api_url": "/api", + "name": "Foreign input sets", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/foreign_input_sets/index", + "name": "index", + "apis": [ + { + "api_url": "/api/templates/:template_id/foreign_input_sets", + "http_method": "GET", + "short_description": "List foreign input sets", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreign_input_sets/show", + "name": "show", + "apis": [ + { + "api_url": "/api/templates/:template_id/foreign_input_sets/:id", + "http_method": "GET", + "short_description": "Show foreign input set details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreign_input_sets/create", + "name": "create", + "apis": [ + { + "api_url": "/api/templates/:template_id/foreign_input_sets", + "http_method": "POST", + "short_description": "Create a foreign input set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "foreign_input_set", + "full_name": "foreign_input_set", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "target_template_id", + "full_name": "foreign_input_set[target_template_id]", + "description": "\n

Target template ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include_all", + "full_name": "foreign_input_set[include_all]", + "description": "\n

Include all inputs from the foreign template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include", + "full_name": "foreign_input_set[include]", + "description": "\n

A comma separated list of input names to be included from the foreign\ntemplate.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "exclude", + "full_name": "foreign_input_set[exclude]", + "description": "\n

A comma separated list of input names to be included from the foreign\ntemplate.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "foreign_input_set[description]", + "description": "\n

Input set description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreign_input_sets/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/templates/:template_id/foreign_input_sets/:id", + "http_method": "DELETE", + "short_description": "Delete a foreign input set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/foreign_input_sets/update", + "name": "update", + "apis": [ + { + "api_url": "/api/templates/:template_id/foreign_input_sets/:id", + "http_method": "PUT", + "short_description": "Update a foreign input set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template_id", + "full_name": "template_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "foreign_input_set", + "full_name": "foreign_input_set", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "target_template_id", + "full_name": "foreign_input_set[target_template_id]", + "description": "\n

Target template ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include_all", + "full_name": "foreign_input_set[include_all]", + "description": "\n

Include all inputs from the foreign template

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include", + "full_name": "foreign_input_set[include]", + "description": "\n

A comma separated list of input names to be included from the foreign\ntemplate.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "exclude", + "full_name": "foreign_input_set[exclude]", + "description": "\n

A comma separated list of input names to be included from the foreign\ntemplate.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "foreign_input_set[description]", + "description": "\n

Input set description

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "job_invocations": { + "doc_url": "../apidoc/v2/job_invocations", + "api_url": "/api", + "name": "Job invocations", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/job_invocations/index", + "name": "index", + "apis": [ + { + "api_url": "/api/job_invocations", + "http_method": "GET", + "short_description": "List job invocations", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_invocations/show", + "name": "show", + "apis": [ + { + "api_url": "/api/job_invocations/:id", + "http_method": "GET", + "short_description": "Show job invocation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_invocations/create", + "name": "create", + "apis": [ + { + "api_url": "/api/job_invocations", + "http_method": "POST", + "short_description": "Create a job invocation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_invocation", + "full_name": "job_invocation", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "job_template_id", + "full_name": "job_invocation[job_template_id]", + "description": "\n

The job template to use, parameter is required unless feature was specified

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "targeting_type", + "full_name": "job_invocation[targeting_type]", + "description": "\n

Invocation type, one of {\u201cstatic_query\u201d=>\u201cStatic Query\u201d,\n\u201cdynamic_query\u201d=>\u201cDynamic Query\u201d}

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "randomized_ordering", + "full_name": "job_invocation[randomized_ordering]", + "description": "\n

Execute the jobs on hosts in randomized order

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "inputs", + "full_name": "job_invocation[inputs]", + "description": "\n

Inputs to use

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssh", + "full_name": "job_invocation[ssh]", + "description": "\n

SSH provider specific options

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "effective_user", + "full_name": "job_invocation[ssh][effective_user]", + "description": "\n

What user should be used to run the script (using sudo-like mechanisms).\nDefaults to a template parameter or global setting.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "recurrence", + "full_name": "job_invocation[recurrence]", + "description": "\n

Create a recurring job

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "cron_line", + "full_name": "job_invocation[recurrence][cron_line]", + "description": "\n

How often the job should occur, in the cron format

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_iteration", + "full_name": "job_invocation[recurrence][max_iteration]", + "description": "\n

Repeat a maximum of N times

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "end_time", + "full_name": "job_invocation[recurrence][end_time]", + "description": "\n

Perform no more executions after this time

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "DateTime", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "scheduling", + "full_name": "job_invocation[scheduling]", + "description": "\n

Schedule the job to start at a later time

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "start_at", + "full_name": "job_invocation[scheduling][start_at]", + "description": "\n

Schedule the job for a future time

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "DateTime", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "start_before", + "full_name": "job_invocation[scheduling][start_before]", + "description": "\n

Indicates that the action should be cancelled if it cannot be started\nbefore this time.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "DateTime", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "concurrency_control", + "full_name": "job_invocation[concurrency_control]", + "description": "\n

Control concurrency level and distribution over time

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "time_span", + "full_name": "job_invocation[concurrency_control][time_span]", + "description": "\n

Distribute tasks over N seconds

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "concurrency_level", + "full_name": "job_invocation[concurrency_control][concurrency_level]", + "description": "\n

Run at most N tasks at a time

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "bookmark_id", + "full_name": "job_invocation[bookmark_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search_query", + "full_name": "job_invocation[search_query]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description_format", + "full_name": "job_invocation[description_format]", + "description": "\n

Override the description format from the template for this invocation only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "execution_timeout_interval", + "full_name": "job_invocation[execution_timeout_interval]", + "description": "\n

Override the timeout interval from the template for this invocation only

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "feature", + "full_name": "job_invocation[feature]", + "description": "\n

Remote execution feature label that should be triggered, job template\nassigned to this feature will be used

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_invocations/output", + "name": "output", + "apis": [ + { + "api_url": "/api/job_invocations/:id/hosts/:host_id", + "http_method": "GET", + "short_description": "Get output for a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "since", + "full_name": "since", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_invocations/raw_output", + "name": "raw_output", + "apis": [ + { + "api_url": "/api/job_invocations/:id/hosts/:host_id/raw", + "http_method": "GET", + "short_description": "Get raw output for a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_invocations/cancel", + "name": "cancel", + "apis": [ + { + "api_url": "/api/job_invocations/:id/cancel", + "http_method": "POST", + "short_description": "Cancel job invocation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "force", + "full_name": "force", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_invocations/rerun", + "name": "rerun", + "apis": [ + { + "api_url": "/api/job_invocations/:id/rerun", + "http_method": "POST", + "short_description": "Rerun job on failed hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "failed_only", + "full_name": "failed_only", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "job_templates": { + "doc_url": "../apidoc/v2/job_templates", + "api_url": "/api", + "name": "Job templates", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/job_templates/index", + "name": "index", + "apis": [ + { + "api_url": "/api/job_templates", + "http_method": "GET", + "short_description": "List job templates", + "deprecated": null + }, + { + "api_url": "/api/locations/:location_id/job_templates", + "http_method": "GET", + "short_description": "List job templates per location", + "deprecated": null + }, + { + "api_url": "/api/organizations/:organization_id/job_templates", + "http_method": "GET", + "short_description": "List job templates per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Scope by locations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Scope by organizations

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/import", + "name": "import", + "apis": [ + { + "api_url": "/api/job_templates/import", + "http_method": "POST", + "short_description": "Import a job template from ERB", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "template", + "description": "\n

Template ERB

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "overwrite", + "full_name": "overwrite", + "description": "\n

Overwrite template if it already exists

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/export", + "name": "export", + "apis": [ + { + "api_url": "/api/job_templates/:id/export", + "http_method": "GET", + "short_description": "Export a job template to ERB", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/show", + "name": "show", + "apis": [ + { + "api_url": "/api/job_templates/:id", + "http_method": "GET", + "short_description": "Show job template details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/create", + "name": "create", + "apis": [ + { + "api_url": "/api/job_templates", + "http_method": "POST", + "short_description": "Create a job template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_template", + "full_name": "job_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "job_template[name]", + "description": "\n

Template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "job_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_category", + "full_name": "job_template[job_category]", + "description": "\n

Job category

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description_format", + "full_name": "job_template[description_format]", + "description": "\n

This template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "job_template[template]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider_type", + "full_name": "job_template[provider_type]", + "description": "\n

Provider type

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: SSH, Ansible.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "job_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "job_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "job_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "effective_user_attributes", + "full_name": "job_template[effective_user_attributes]", + "description": "\n

Effective user options

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "value", + "full_name": "job_template[effective_user_attributes][value]", + "description": "\n

What user should be used to run the script (using sudo-like mechanisms)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "overridable", + "full_name": "job_template[effective_user_attributes][overridable]", + "description": "\n

Whether it should be allowed to override the effective user from the\ninvocation form.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "current_user", + "full_name": "job_template[effective_user_attributes][current_user]", + "description": "\n

Whether the current user login should be used as the effective user

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "location_ids", + "full_name": "job_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "job_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/update", + "name": "update", + "apis": [ + { + "api_url": "/api/job_templates/:id", + "http_method": "PUT", + "short_description": "Update a job template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_template", + "full_name": "job_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "job_template[name]", + "description": "\n

Template name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "job_template[description]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_category", + "full_name": "job_template[job_category]", + "description": "\n

Job category

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description_format", + "full_name": "job_template[description_format]", + "description": "\n

This template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "template", + "full_name": "job_template[template]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provider_type", + "full_name": "job_template[provider_type]", + "description": "\n

Provider type

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: SSH, Ansible.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snippet", + "full_name": "job_template[snippet]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "audit_comment", + "full_name": "job_template[audit_comment]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "locked", + "full_name": "job_template[locked]", + "description": "\n

Whether or not the template is locked for editing

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "effective_user_attributes", + "full_name": "job_template[effective_user_attributes]", + "description": "\n

Effective user options

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "value", + "full_name": "job_template[effective_user_attributes][value]", + "description": "\n

What user should be used to run the script (using sudo-like mechanisms)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "overridable", + "full_name": "job_template[effective_user_attributes][overridable]", + "description": "\n

Whether it should be allowed to override the effective user from the\ninvocation form.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "current_user", + "full_name": "job_template[effective_user_attributes][current_user]", + "description": "\n

Whether the current user login should be used as the effective user

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "location_ids", + "full_name": "job_template[location_ids]", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "job_template[organization_ids]", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/revision", + "name": "revision", + "apis": [ + { + "api_url": "/api/job_templates/revision", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

Template version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/job_templates/:id", + "http_method": "DELETE", + "short_description": "Delete a job template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/job_templates/clone", + "name": "clone", + "apis": [ + { + "api_url": "/api/job_templates/:id/clone", + "http_method": "POST", + "short_description": "Clone a provision template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_template", + "full_name": "job_template", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "job_template[name]", + "description": "\n

Template name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "remote_execution_features": { + "doc_url": "../apidoc/v2/remote_execution_features", + "api_url": "/api", + "name": "Remote execution features", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/remote_execution_features/index", + "name": "index", + "apis": [ + { + "api_url": "/api/remote_execution_features", + "http_method": "GET", + "short_description": "List remote execution features", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/remote_execution_features/show", + "name": "show", + "apis": [ + { + "api_url": "/api/remote_execution_features/:id", + "http_method": "GET", + "short_description": "Show remote execution feature", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/remote_execution_features/update", + "name": "update", + "apis": [ + { + "api_url": "/api/remote_execution_features/:id", + "http_method": "PUT", + "short_description": "Update a job template", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "remote_execution_feature", + "full_name": "remote_execution_feature", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "job_template_id", + "full_name": "remote_execution_feature[job_template_id]", + "description": "\n

Job template ID to be used for the feature

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "template_invocations": { + "doc_url": "../apidoc/v2/template_invocations", + "api_url": "/api", + "name": "Template invocations", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/template_invocations/template_invocations", + "name": "template_invocations", + "apis": [ + { + "api_url": "/api/job_invocations/:job_invocation_id/template_invocations", + "http_method": "GET", + "short_description": "List template invocations belonging to job invocation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "job_invocation_id", + "full_name": "job_invocation_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "puppet_modules": { + "doc_url": "../apidoc/v2/puppet_modules", + "api_url": "/api", + "name": "Puppet modules", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/puppet_modules/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/puppet_modules", + "http_method": "GET", + "short_description": "List puppet_modules", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules", + "http_method": "GET", + "short_description": "List puppet_modules", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/puppet_modules", + "http_method": "GET", + "short_description": "List puppet_modules", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/puppet_modules", + "http_method": "GET", + "short_description": "List puppet_modules", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/puppet_modules/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/puppet_modules/:id", + "http_method": "GET", + "short_description": "Show a puppet module", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/puppet_modules/:id", + "http_method": "GET", + "short_description": "Show a puppet module", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a puppet module identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/puppet_modules/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/puppet_modules/compare", + "http_method": "GET", + "short_description": "List puppet_modules", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "activation_keys": { + "doc_url": "../apidoc/v2/activation_keys", + "api_url": "/api", + "name": "Activation keys", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/activation_keys/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/activation_keys", + "http_method": "GET", + "short_description": "List activation keys", + "deprecated": null + }, + { + "api_url": "/katello/api/environments/:environment_id/activation_keys", + "http_method": "GET", + "short_description": null, + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/activation_keys", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

activation key name to filter by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "addon", + "type": "string" + }, + { + "name": "content_view", + "type": "string" + }, + { + "name": "content_view_id", + "type": "integer" + }, + { + "name": "description", + "type": "text" + }, + { + "name": "environment", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "role", + "type": "string" + }, + { + "name": "subscription_id", + "type": "string" + }, + { + "name": "subscription_name", + "type": "string" + }, + { + "name": "usage", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/activation_keys", + "http_method": "POST", + "short_description": "Create an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment", + "full_name": "environment", + "description": "\n

environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_hosts", + "full_name": "max_hosts", + "description": "\n

maximum number of registered content hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "unlimited_hosts", + "full_name": "unlimited_hosts", + "description": "\n

can the activation key have unlimited hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "release_version", + "full_name": "release_version", + "description": "\n

content release version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "service_level", + "full_name": "service_level", + "description": "\n

service level

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auto_attach", + "full_name": "auto_attach", + "description": "\n

auto attach subscriptions upon registration

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_usage", + "full_name": "purpose_usage", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_role", + "full_name": "purpose_role", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_addons", + "full_name": "purpose_addons", + "description": "\n

Sets the system add-ons

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id", + "http_method": "PUT", + "short_description": "Update an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_hosts", + "full_name": "max_hosts", + "description": "\n

maximum number of registered content hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "unlimited_hosts", + "full_name": "unlimited_hosts", + "description": "\n

can the activation key have unlimited hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "release_version", + "full_name": "release_version", + "description": "\n

content release version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "service_level", + "full_name": "service_level", + "description": "\n

service level

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auto_attach", + "full_name": "auto_attach", + "description": "\n

auto attach subscriptions upon registration

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_usage", + "full_name": "purpose_usage", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_role", + "full_name": "purpose_role", + "description": "\n

Sets the system purpose usage

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "purpose_addons", + "full_name": "purpose_addons", + "description": "\n

Sets the system add-ons

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id", + "http_method": "DELETE", + "short_description": "Destroy an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id", + "http_method": "GET", + "short_description": "Show an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/copy", + "name": "copy", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/copy", + "http_method": "POST", + "short_description": "Copy an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "new_name", + "full_name": "new_name", + "description": "\n

Name of new activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/available_host_collections", + "name": "available_host_collections", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/host_collections/available", + "http_method": "GET", + "short_description": "List host collections the activation key does not belong to", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

host collection name to filter by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/available_releases", + "name": "available_releases", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/releases", + "http_method": "GET", + "short_description": "Show release versions available for an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/product_content", + "name": "product_content", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/product_content", + "http_method": "GET", + "short_description": "Show content available for an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_access_mode_all", + "full_name": "content_access_mode_all", + "description": "\n

Get all content available, not just that provided by subscriptions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_access_mode_env", + "full_name": "content_access_mode_env", + "description": "\n

Limit content to just that available in the activation key's content\nview version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/add_host_collections", + "name": "add_host_collections", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/host_collections", + "http_method": "POST", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_collection_ids", + "full_name": "host_collection_ids", + "description": "\n

List of host collection IDs to associate with activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/remove_host_collections", + "name": "remove_host_collections", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/host_collections", + "http_method": "PUT", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_collection_ids", + "full_name": "host_collection_ids", + "description": "\n

List of host collection IDs to disassociate from the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/add_subscriptions", + "name": "add_subscriptions", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/add_subscriptions", + "http_method": "PUT", + "short_description": "Attach a subscription", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscription_id", + "full_name": "subscription_id", + "description": "\n

Subscription identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "quantity", + "description": "\n

Quantity of this subscription to add

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to add

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool uuid

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "subscriptions[quantity]", + "description": "\n

Quantity of this subscriptions to add

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/remove_subscriptions", + "name": "remove_subscriptions", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/remove_subscriptions", + "http_method": "PUT", + "short_description": "Unattach a subscription", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscription_id", + "full_name": "subscription_id", + "description": "\n

Subscription ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to add

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool uuid

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/activation_keys/content_override", + "name": "content_override", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:id/content_override", + "http_method": "PUT", + "short_description": "Override content for activation_key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the activation key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_overrides", + "full_name": "content_overrides", + "description": "\n

Array of Content override parameters to be added in bulk

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_label", + "full_name": "content_overrides[content_label]", + "description": "\n

Label of the content

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "content_overrides[value]", + "description": "\n

Override value. Provide a boolean value if name is 'enabled'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "content_overrides[name]", + "description": "\n

Override parameter key or name. Note if name is not provided the default\nname will be 'enabled'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "remove", + "full_name": "content_overrides[remove]", + "description": "\n

Set true to remove an override and reset it to 'default'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "repositories_bulk_actions": { + "doc_url": "../apidoc/v2/repositories_bulk_actions", + "api_url": "/api", + "name": "Repositories bulk actions", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/repositories_bulk_actions/destroy_repositories", + "name": "destroy_repositories", + "apis": [ + { + "api_url": "/katello/api/repositories/bulk/destroy", + "http_method": "PUT", + "short_description": "Destroy one or more repositories", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "ids", + "full_name": "ids", + "description": "\n

List of repository ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories_bulk_actions/sync_repositories", + "name": "sync_repositories", + "apis": [ + { + "api_url": "/katello/api/repositories/bulk/sync", + "http_method": "POST", + "short_description": "Synchronize repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "ids", + "full_name": "ids", + "description": "\n

List of repository ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "ansible_collections": { + "doc_url": "../apidoc/v2/ansible_collections", + "api_url": "/api", + "name": "Ansible Collections", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ansible_collections/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/ansible_collections", + "http_method": "GET", + "short_description": "List ansible_collections", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections", + "http_method": "GET", + "short_description": "List ansible_collections", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/ansible_collections", + "http_method": "GET", + "short_description": "List ansible_collections", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/ansible_collections", + "http_method": "GET", + "short_description": "List ansible_collections", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_collections/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/ansible_collections/:id", + "http_method": "GET", + "short_description": "Show an ansible collection", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/ansible_collections/:id", + "http_method": "GET", + "short_description": "Show an ansible collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

an ansible collection identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_collections/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/ansible_collections/compare", + "http_method": "GET", + "short_description": "List :resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "repositories": { + "doc_url": "../apidoc/v2/repositories", + "api_url": "/api", + "name": "Repositories", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/repositories/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/repositories", + "http_method": "GET", + "short_description": "List of enabled repositories", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:id/repositories", + "http_method": "GET", + "short_description": "List of repositories for a content view", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/repositories", + "http_method": "GET", + "short_description": "List of repositories in an organization", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/environments/:environment_id/repositories", + "http_method": "GET", + "short_description": "List repositories in the environment", + "deprecated": null + }, + { + "api_url": "/katello/api/products/:product_id/repositories", + "http_method": "GET", + "short_description": "List of repositories for a product", + "deprecated": null + }, + { + "api_url": "/katello/api/environments/:environment_id/products/:product_id/repositories", + "http_method": "GET", + "short_description": "List of repositories belonging to a product in an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of an organization to show repositories in

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

ID of a product to show repositories of

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

ID of an environment to show repositories in

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

ID of a content view to show repositories in

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

ID of a content view version to show repositories in

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_id", + "full_name": "deb_id", + "description": "\n

Id of a deb package to find repositories that contain the deb

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "erratum_id", + "full_name": "erratum_id", + "description": "\n

Id of an erratum to find repositories that contain the erratum

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "rpm_id", + "full_name": "rpm_id", + "description": "\n

Id of a rpm package to find repositories that contain the rpm

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "file_id", + "full_name": "file_id", + "description": "\n

Id of a file to find repositories that contain the file

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_collection_id", + "full_name": "ansible_collection_id", + "description": "\n

Id of an ansible collection to find repositories that contain the ansible\ncollection

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ostree_branch_id", + "full_name": "ostree_branch_id", + "description": "\n

Id of an ostree branch to find repositories that contain that branch

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "library", + "full_name": "library", + "description": "\n

show repositories in Library and the default content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "archived", + "full_name": "archived", + "description": "\n

show archived repositories

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

limit to only repositories of this type

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: deb, docker, file, puppet, yum.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "\n

label of the repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description of the repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

interpret specified object to return only Repositories that can be\nassociated with specified object. Only 'content_view' &\n'content_view_version' are supported.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "with_content", + "full_name": "with_content", + "description": "\n

only repositories having at least one of the specified content type ex: rpm\n, erratum

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: erratum, deb, docker_manifest, docker_manifest_list, docker_tag, docker_blob, file, puppet_module, rpm, modulemd, erratum, distribution, package_category, package_group, yum_repo_metadata_file, srpm.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "container_repository_name", + "type": "string" + }, + { + "name": "content_label", + "type": "string" + }, + { + "name": "content_type", + "type": "string" + }, + { + "name": "content_view_id", + "type": "integer" + }, + { + "name": "description", + "type": "text" + }, + { + "name": "distribution_arch", + "type": "string" + }, + { + "name": "distribution_bootable", + "type": "boolean" + }, + { + "name": "distribution_family", + "type": "string" + }, + { + "name": "distribution_uuid", + "type": "string" + }, + { + "name": "distribution_variant", + "type": "string" + }, + { + "name": "distribution_version", + "type": "string" + }, + { + "name": "label", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "product", + "type": "string" + }, + { + "name": "product_id", + "type": "integer" + }, + { + "name": "product_name", + "type": "string" + }, + { + "name": "redhat", + "values": [ + "true", + "false" + ] + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/repositories", + "http_method": "POST", + "short_description": "Create a custom repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "name", + "full_name": "name", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

Product the repository belongs to

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

type of repo

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: deb, docker, file, puppet, yum.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "url", + "description": "\n

repository source url

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gpg_key_id", + "full_name": "gpg_key_id", + "description": "\n

id of the gpg key that will be assigned to the new repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_ca_cert_id", + "full_name": "ssl_ca_cert_id", + "description": "\n

Idenifier of the SSL CA Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_cert_id", + "full_name": "ssl_client_cert_id", + "description": "\n

Identifier of the SSL Client Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_key_id", + "full_name": "ssl_client_key_id", + "description": "\n

Identifier of the SSL Client Key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "unprotected", + "full_name": "unprotected", + "description": "\n

true if this repository can be published via HTTP

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "checksum_type", + "full_name": "checksum_type", + "description": "\n

Checksum of the repository, currently 'sha1' & 'sha256'\nare supported

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "docker_upstream_name", + "full_name": "docker_upstream_name", + "description": "\n

Name of the upstream docker repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "docker_tags_whitelist", + "full_name": "docker_tags_whitelist", + "description": "\n

Comma separated list of tags to sync for Container Image repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "download_policy", + "full_name": "download_policy", + "description": "\n

download policy for yum repos (either 'immediate',\n'on_demand', or 'background')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: immediate, on_demand, background.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mirror_on_sync", + "full_name": "mirror_on_sync", + "description": "\n

true if this repository when synced has to be mirrored from the source and\nstale rpms removed

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "verify_ssl_on_sync", + "full_name": "verify_ssl_on_sync", + "description": "\n

if true, foreman will verify the upstream url's SSL certifcates are\nsigned by a trusted CA

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upstream_username", + "full_name": "upstream_username", + "description": "\n

Username of the upstream repository user used for authentication

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upstream_password", + "full_name": "upstream_password", + "description": "\n

Password of the upstream repository user used for authentication

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ostree_upstream_sync_policy", + "full_name": "ostree_upstream_sync_policy", + "description": "\n

policies for syncing upstream ostree repositories

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: latest, all, custom.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ostree_upstream_sync_depth", + "full_name": "ostree_upstream_sync_depth", + "description": "\n

if a custom sync policy is chosen for ostree repositories then a\n'depth' value must be provided

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_releases", + "full_name": "deb_releases", + "description": "\n

comma separated list of releases to be synched from deb-archive

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_components", + "full_name": "deb_components", + "description": "\n

comma separated list of repo components to be synched from deb-archive

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_architectures", + "full_name": "deb_architectures", + "description": "\n

comma separated list of architectures to be synched from deb-archive

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignore_global_proxy", + "full_name": "ignore_global_proxy", + "description": "\n

if true, will ignore the globally configured proxy when syncing

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_errata_url", + "full_name": "deb_errata_url", + "description": "\n

URL to a deb_errata service (use only on the security repositories)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignorable_content", + "full_name": "ignorable_content", + "description": "\n

List of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_collection_requirements", + "full_name": "ansible_collection_requirements", + "description": "\n

Contents of requirement yaml file to sync from URL

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy_policy", + "full_name": "http_proxy_policy", + "description": "\n

policies for http proxy for content sync

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: global_default_http_proxy, none, use_selected_http_proxy.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy_id", + "full_name": "http_proxy_id", + "description": "\n

ID of a HTTP Proxy

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/repository_types", + "name": "repository_types", + "apis": [ + { + "api_url": "/katello/api/repositories/repository_types", + "http_method": "GET", + "short_description": "Show the available repository types", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "creatable", + "full_name": "creatable", + "description": "\n

When set to 'True' repository types that are creatable will be\nreturned

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/republish", + "name": "republish", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/republish", + "http_method": "PUT", + "short_description": "Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Repository identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/repositories/:id", + "http_method": "GET", + "short_description": "Show a repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

repository ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/sync", + "name": "sync", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/sync", + "http_method": "POST", + "short_description": "Sync a repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

repository ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "source_url", + "full_name": "source_url", + "description": "\n

temporarily override feed URL for sync

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "incremental", + "full_name": "incremental", + "description": "\n

perform an incremental import

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "skip_metadata_check", + "full_name": "skip_metadata_check", + "description": "\n

Force sync even if no upstream changes are detected. Only used with yum\nrepositories.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validate_contents", + "full_name": "validate_contents", + "description": "\n

Force a sync and validate the checksums of all content. Only used with yum\nrepositories.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/export", + "name": "export", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/export", + "http_method": "POST", + "short_description": "Export a repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Repository identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "export_to_iso", + "full_name": "export_to_iso", + "description": "\n

Export to ISO format

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "iso_mb_size", + "full_name": "iso_mb_size", + "description": "\n

maximum size of each ISO in MB

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "since", + "full_name": "since", + "description": "\n

Optional date of last export (ex: 2010-01-01T12:00:00Z)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Date", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/repositories/:id", + "http_method": "PUT", + "short_description": "Update a repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

repository ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "url", + "full_name": "url", + "description": "\n

repository source url

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gpg_key_id", + "full_name": "gpg_key_id", + "description": "\n

id of the gpg key that will be assigned to the new repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_ca_cert_id", + "full_name": "ssl_ca_cert_id", + "description": "\n

Idenifier of the SSL CA Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_cert_id", + "full_name": "ssl_client_cert_id", + "description": "\n

Identifier of the SSL Client Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_key_id", + "full_name": "ssl_client_key_id", + "description": "\n

Identifier of the SSL Client Key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "unprotected", + "full_name": "unprotected", + "description": "\n

true if this repository can be published via HTTP

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "checksum_type", + "full_name": "checksum_type", + "description": "\n

Checksum of the repository, currently 'sha1' & 'sha256'\nare supported

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "docker_upstream_name", + "full_name": "docker_upstream_name", + "description": "\n

Name of the upstream docker repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "docker_tags_whitelist", + "full_name": "docker_tags_whitelist", + "description": "\n

Comma separated list of tags to sync for Container Image repository

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "download_policy", + "full_name": "download_policy", + "description": "\n

download policy for yum repos (either 'immediate',\n'on_demand', or 'background')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: immediate, on_demand, background.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mirror_on_sync", + "full_name": "mirror_on_sync", + "description": "\n

true if this repository when synced has to be mirrored from the source and\nstale rpms removed

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "verify_ssl_on_sync", + "full_name": "verify_ssl_on_sync", + "description": "\n

if true, foreman will verify the upstream url's SSL certifcates are\nsigned by a trusted CA

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upstream_username", + "full_name": "upstream_username", + "description": "\n

Username of the upstream repository user used for authentication

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upstream_password", + "full_name": "upstream_password", + "description": "\n

Password of the upstream repository user used for authentication

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ostree_upstream_sync_policy", + "full_name": "ostree_upstream_sync_policy", + "description": "\n

policies for syncing upstream ostree repositories

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: latest, all, custom.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ostree_upstream_sync_depth", + "full_name": "ostree_upstream_sync_depth", + "description": "\n

if a custom sync policy is chosen for ostree repositories then a\n'depth' value must be provided

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_releases", + "full_name": "deb_releases", + "description": "\n

comma separated list of releases to be synched from deb-archive

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_components", + "full_name": "deb_components", + "description": "\n

comma separated list of repo components to be synched from deb-archive

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_architectures", + "full_name": "deb_architectures", + "description": "\n

comma separated list of architectures to be synched from deb-archive

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignore_global_proxy", + "full_name": "ignore_global_proxy", + "description": "\n

if true, will ignore the globally configured proxy when syncing

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_errata_url", + "full_name": "deb_errata_url", + "description": "\n

URL to a deb_errata service (use only on the security repositories)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ignorable_content", + "full_name": "ignorable_content", + "description": "\n

List of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_collection_requirements", + "full_name": "ansible_collection_requirements", + "description": "\n

Contents of requirement yaml file to sync from URL

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy_policy", + "full_name": "http_proxy_policy", + "description": "\n

policies for http proxy for content sync

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: global_default_http_proxy, none, use_selected_http_proxy.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy_id", + "full_name": "http_proxy_id", + "description": "\n

ID of a HTTP Proxy

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/repositories/:id", + "http_method": "DELETE", + "short_description": "Destroy a custom repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/remove_content", + "name": "remove_content", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/remove_packages", + "http_method": "PUT", + "short_description": null, + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:id/remove_docker_manifests", + "http_method": "PUT", + "short_description": null, + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:id/remove_puppet_modules", + "http_method": "PUT", + "short_description": null, + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:id/remove_content", + "http_method": "PUT", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "\n

Remove content from a repository

\n", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

repository ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

Array of content ids to remove

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

content type ('deb', 'docker_manifest', 'file',\n'ostree', 'puppet_module', 'rpm', 'srpm')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: deb, docker_manifest, file, puppet_module, rpm, srpm.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_capsule", + "full_name": "sync_capsule", + "description": "\n

Whether or not to sync an external capsule after upload. Default: true

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/upload_content", + "name": "upload_content", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/upload_content", + "http_method": "POST", + "short_description": "Upload content into the repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

repository ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

Content files to upload. Can be a single file or array of files.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "File", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

content type ('deb', 'docker_manifest', 'file',\n'ostree', 'puppet_module', 'rpm', 'srpm')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: deb, docker_manifest, file, puppet_module, rpm, srpm.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/import_uploads", + "name": "import_uploads", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/import_uploads", + "http_method": "PUT", + "short_description": "Import uploads into a repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Repository id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "upload_ids", + "full_name": "upload_ids", + "description": "\n

Array of upload ids to import

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "async", + "full_name": "async", + "description": "\n

Do not wait for the ImportUpload action to finish. Default: false

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "publish_repository", + "full_name": "publish_repository", + "description": "\n

Whether or not to regenerate the repository on disk. Default: true

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_capsule", + "full_name": "sync_capsule", + "description": "\n

Whether or not to sync an external capsule after upload. Default: true

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

content type ('deb', 'docker_manifest', 'file',\n'ostree', 'puppet_module', 'rpm', 'srpm')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: deb, docker_manifest, file, puppet_module, rpm, srpm.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uploads", + "full_name": "uploads", + "description": "\n

Array of uploads to import

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "uploads[id]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_unit_id", + "full_name": "uploads[content_unit_id]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "size", + "full_name": "uploads[size]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "checksum", + "full_name": "uploads[checksum]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "uploads[name]", + "description": "\n

Needs to only be set for file repositories or docker tags

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "digest", + "full_name": "uploads[digest]", + "description": "\n

Needs to only be set for docker tags

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repositories/gpg_key_content", + "name": "gpg_key_content", + "apis": [ + { + "api_url": "/katello/api/repositories/:id/gpg_key_content", + "http_method": "GET", + "short_description": "Return the content of a repo gpg key, used directly by yum", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "capsule_content": { + "doc_url": "../apidoc/v2/capsule_content", + "api_url": "/api", + "name": "Capsule content", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/capsule_content/lifecycle_environments", + "name": "lifecycle_environments", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/lifecycle_environments", + "http_method": "GET", + "short_description": "List the lifecycle environments attached to the smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Id of the organization to limit environments on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsule_content/available_lifecycle_environments", + "name": "available_lifecycle_environments", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/available_lifecycle_environments", + "http_method": "GET", + "short_description": "List the lifecycle environments not attached to the smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Id of the organization to limit environments on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsule_content/add_lifecycle_environment", + "name": "add_lifecycle_environment", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/lifecycle_environments", + "http_method": "POST", + "short_description": "Add lifecycle environments to the smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Id of the lifecycle environment

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsule_content/remove_lifecycle_environment", + "name": "remove_lifecycle_environment", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/lifecycle_environments/:environment_id", + "http_method": "DELETE", + "short_description": "Remove lifecycle environments from the smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Id of the lifecycle environment

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsule_content/sync", + "name": "sync", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/sync", + "http_method": "POST", + "short_description": "Synchronize the content to the smart proxy", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Id of the environment to limit the synchronization on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "skip_metadata_check", + "full_name": "skip_metadata_check", + "description": "\n

Skip metadata check on each repository on the smart proxy

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsule_content/sync_status", + "name": "sync_status", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/sync", + "http_method": "GET", + "short_description": "Get current smart proxy synchronization status", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Id of the organization to get the status for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsule_content/cancel_sync", + "name": "cancel_sync", + "apis": [ + { + "api_url": "/katello/api/capsules/:id/content/sync", + "http_method": "DELETE", + "short_description": "Cancel running smart proxy synchronization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "capsules": { + "doc_url": "../apidoc/v2/capsules", + "api_url": "/api", + "name": "Capsules", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/capsules/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/capsules", + "http_method": "GET", + "short_description": "List all smart proxies that have content", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/capsules/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/capsules/:id", + "http_method": "GET", + "short_description": "Show the smart proxy details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the smart proxy

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "repository_sets": { + "doc_url": "../apidoc/v2/repository_sets", + "api_url": "/api", + "name": "Repository sets", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/repository_sets/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/repository_sets", + "http_method": "GET", + "short_description": "List repository sets.", + "deprecated": null + }, + { + "api_url": "/katello/api/products/:product_id/repository_sets", + "http_method": "GET", + "short_description": "List repository sets for a product.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

ID of a product to list repository sets from

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Repository set name to search on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "enabled", + "description": "\n

If true, only return repository sets that have been enabled. Defaults to\nfalse

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "with_active_subscription", + "full_name": "with_active_subscription", + "description": "\n

If true, only return repository sets that are associated with an active\nsubscriptions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "with_custom", + "full_name": "with_custom", + "description": "\n

If true, return custom repository sets along with redhat repos

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "content_label", + "type": "string" + }, + { + "name": "content_type", + "type": "string" + }, + { + "name": "label", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "product_id", + "type": "integer" + }, + { + "name": "product_name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repository_sets/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/repository_sets/:id", + "http_method": "GET", + "short_description": "Get info about a repository set", + "deprecated": null + }, + { + "api_url": "/katello/api/products/:product_id/repository_sets/:id", + "http_method": "GET", + "short_description": "Get info about a repository set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the repository set

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

ID of a product to list repository sets from

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repository_sets/available_repositories", + "name": "available_repositories", + "apis": [ + { + "api_url": "/katello/api/repository_sets/:id/available_repositories", + "http_method": "GET", + "short_description": "Get list of available repositories for the repository set", + "deprecated": null + }, + { + "api_url": "/katello/api/products/:product_id/repository_sets/:id/available_repositories", + "http_method": "GET", + "short_description": "Get list of available repositories for the repository set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the repository set

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

ID of a product to list repository sets from

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repository_sets/enable", + "name": "enable", + "apis": [ + { + "api_url": "/katello/api/repository_sets/:id/enable", + "http_method": "PUT", + "short_description": "Enable a repository from the set", + "deprecated": null + }, + { + "api_url": "/katello/api/products/:product_id/repository_sets/:id/enable", + "http_method": "PUT", + "short_description": "Enable a repository from the set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the repository set to enable

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

ID of the product containing the repository set

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "basearch", + "full_name": "basearch", + "description": "\n

Basearch to enable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "releasever", + "full_name": "releasever", + "description": "\n

Releasever to enable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/repository_sets/disable", + "name": "disable", + "apis": [ + { + "api_url": "/katello/api/repository_sets/:id/disable", + "http_method": "PUT", + "short_description": "Disable a repository from the set", + "deprecated": null + }, + { + "api_url": "/katello/api/products/:product_id/repository_sets/:id/disable", + "http_method": "PUT", + "short_description": "Disable a repository from the set", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the repository set to disable

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_id", + "full_name": "product_id", + "description": "\n

ID of the product containing the repository set

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "basearch", + "full_name": "basearch", + "description": "\n

Basearch to disable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "releasever", + "full_name": "releasever", + "description": "\n

Releasever to disable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "content_credentials": { + "doc_url": "../apidoc/v2/content_credentials", + "api_url": "/api", + "name": "Content credentials", + "short_description": null, + "full_description": "\n

# Description

\n\n

Content Credentials are used to store credentials like GPG Keys and\nCertificates for the authentication to Products / Repositories.

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_credentials/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_credentials", + "http_method": "GET", + "short_description": "List content credentials", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the Content Credential

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

type of content

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_credentials/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/content_credentials", + "http_method": "POST", + "short_description": "Create a content credential", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

identifier of the content credential

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

type of content

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

public key block in DER encoding or certificate content

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_credentials/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_credentials/:id", + "http_method": "GET", + "short_description": "Show a content credential", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content credential numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_credentials/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_credentials/:id", + "http_method": "PUT", + "short_description": "Update a content credential", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content credential numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

identifier of the content credential

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

type of content

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

public key block in DER encoding or certificate content

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_credentials/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/content_credentials/:id", + "http_method": "DELETE", + "short_description": "Destroy a content credential", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content credential numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_credentials/content", + "name": "content", + "apis": [ + { + "api_url": "/katello/api/content_credentials/:id/content", + "http_method": "GET", + "short_description": "Return the content of a content credential, used directly by yum", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_credentials/set_content", + "name": "set_content", + "apis": [ + { + "api_url": "/katello/api/content_credentials/:id/content", + "http_method": "POST", + "short_description": "Upload content credential contents", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content credential numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

file contents

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "File", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "content_uploads": { + "doc_url": "../apidoc/v2/content_uploads", + "api_url": "/api", + "name": "Content uploads", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_uploads/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/repositories/:repository_id/content_uploads", + "http_method": "POST", + "short_description": "Create an upload request", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "size", + "full_name": "size", + "description": "\n

Size of file to upload

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "checksum", + "full_name": "checksum", + "description": "\n

Checksum of file to upload

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

content type ('deb', 'docker_manifest', 'file',\n'ostree', 'puppet_module', 'rpm', 'srpm')

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: deb, docker_manifest, file, puppet_module, rpm, srpm.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_uploads/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/repositories/:repository_id/content_uploads/:id", + "http_method": "PUT", + "short_description": "Upload a chunk of the file's content", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Upload request id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "size", + "full_name": "size", + "description": "\n

Size of file to upload

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "offset", + "full_name": "offset", + "description": "\n

The offset in the file where the content starts

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

The actual file contents

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "File", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_uploads/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/repositories/:repository_id/content_uploads/:id", + "http_method": "DELETE", + "short_description": "Delete an upload request", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Upload request id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "packages": { + "doc_url": "../apidoc/v2/packages", + "api_url": "/api", + "name": "Packages", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/packages/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/packages", + "http_method": "GET", + "short_description": "List packages", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id", + "http_method": "GET", + "short_description": "List :resource_id", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/:resource_id", + "http_method": "GET", + "short_description": "List :resource_id", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/:resource_id", + "http_method": "GET", + "short_description": "List :resource_id", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

Content View Version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

Content View Filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

Package identifiers to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host id to list applicable packages for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages_restrict_applicable", + "full_name": "packages_restrict_applicable", + "description": "\n

Return packages that are applicable to one or more hosts (defaults to true\nif host_id is specified)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages_restrict_upgradable", + "full_name": "packages_restrict_upgradable", + "description": "\n

Return packages that are upgradable on one or more hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages_restrict_latest", + "full_name": "packages_restrict_latest", + "description": "\n

Return only the latest version of each package

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

Return packages that can be added to the specified object. Only the value\n'content_view_version' is supported.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/packages/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/packages/:id", + "http_method": "GET", + "short_description": "Show a package", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/packages/:id", + "http_method": "GET", + "short_description": "Show a package", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a package identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/packages/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/packages/compare", + "http_method": "GET", + "short_description": "List packages", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "content_view_components": { + "doc_url": "../apidoc/v2/content_view_components", + "api_url": "/api", + "name": "Content view components", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_view_components/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_views/:composite_content_view_id/content_view_components", + "http_method": "GET", + "short_description": "List components attached to this content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "composite_content_view_id", + "full_name": "composite_content_view_id", + "description": "\n

composite content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_components/add_components", + "name": "add_components", + "apis": [ + { + "api_url": "/katello/api/content_views/:composite_content_view_id/content_view_components/add", + "http_method": "PUT", + "short_description": "Add components to the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "composite_content_view_id", + "full_name": "composite_content_view_id", + "description": "\n

composite content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "components", + "full_name": "components", + "description": "\n

Array of components to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_view_version_id", + "full_name": "components[content_view_version_id]", + "description": "\n

identifier of the version of the component content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "components[content_view_id]", + "description": "\n

content view identifier of the component who's latest version is\ndesired

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "latest", + "full_name": "components[latest]", + "description": "\n

true if the latest version of the component's content view is desired

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_components/remove_components", + "name": "remove_components", + "apis": [ + { + "api_url": "/katello/api/content_views/:composite_content_view_id/content_view_components/remove", + "http_method": "PUT", + "short_description": "Remove components from the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "composite_content_view_id", + "full_name": "composite_content_view_id", + "description": "\n

composite content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "component_ids", + "full_name": "component_ids", + "description": "\n

Array of content view component IDs to remove. Identifier of the component\nassociation

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_components/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_views/:composite_content_view_id/content_view_components/:id", + "http_method": "GET", + "short_description": "Show a content view component", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "composite_content_view_id", + "full_name": "composite_content_view_id", + "description": "\n

composite content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

content view component ID. Identifier of the component association

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_components/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_views/:composite_content_view_id/content_view_components/:id", + "http_method": "PUT", + "short_description": "Update a component associated with the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "composite_content_view_id", + "full_name": "composite_content_view_id", + "description": "\n

composite content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

content view component ID. Identifier of the component association

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

identifier of the version of the component content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "latest", + "full_name": "latest", + "description": "\n

true if the latest version of the components content view is desired

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "products_bulk_actions": { + "doc_url": "../apidoc/v2/products_bulk_actions", + "api_url": "/api", + "name": "Products bulk actions", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/products_bulk_actions/destroy_products", + "name": "destroy_products", + "apis": [ + { + "api_url": "/katello/api/products/bulk/destroy", + "http_method": "PUT", + "short_description": "Destroy one or more products", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "ids", + "full_name": "ids", + "description": "\n

List of product ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products_bulk_actions/sync_products", + "name": "sync_products", + "apis": [ + { + "api_url": "/katello/api/products/bulk/sync", + "http_method": "PUT", + "short_description": "Sync one or more products", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "ids", + "full_name": "ids", + "description": "\n

List of product ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "skip_metadata_check", + "full_name": "skip_metadata_check", + "description": "\n

Force sync even if no upstream changes are detected. Non-yum repositories\nare skipped.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validate_contents", + "full_name": "validate_contents", + "description": "\n

Force a sync and validate the checksums of all content. Non-yum\nrepositories (or those with \nOn Demand download policy) are skipped.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products_bulk_actions/update_http_proxy", + "name": "update_http_proxy", + "apis": [ + { + "api_url": "/katello/api/products/bulk/http_proxy", + "http_method": "PUT", + "short_description": "Update the http proxy configuration on the repositories of one or more products.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "ids", + "full_name": "ids", + "description": "\n

List of product ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy_policy", + "full_name": "http_proxy_policy", + "description": "\n

policy for http proxy for content sync

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: global_default_http_proxy, none, use_selected_http_proxy.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "http_proxy_id", + "full_name": "http_proxy_id", + "description": "\n

Http Proxy identifier to associated

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products_bulk_actions/update_sync_plans", + "name": "update_sync_plans", + "apis": [ + { + "api_url": "/katello/api/products/bulk/sync_plan", + "http_method": "PUT", + "short_description": "Sync one or more products", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "ids", + "full_name": "ids", + "description": "\n

List of product ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "plan_id", + "full_name": "plan_id", + "description": "\n

Sync plan identifier to attach

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "content_view_filter_rules": { + "doc_url": "../apidoc/v2/content_view_filter_rules", + "api_url": "/api", + "name": "Content view filter rules", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_view_filter_rules/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/rules", + "http_method": "GET", + "short_description": "List filter rules", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the content view filter rule

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_id", + "full_name": "errata_id", + "description": "\n

errata_id of the content view filter rule

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filter_rules/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/rules", + "http_method": "POST", + "short_description": "Create a filter rule. The parameters included should be based upon the filter type.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

package, package group, or docker tag names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of [String]", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "uuid", + "description": "\n

package group: uuid

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

package: version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture", + "full_name": "architecture", + "description": "\n

package: architecture

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "min_version", + "full_name": "min_version", + "description": "\n

package: minimum version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_version", + "full_name": "max_version", + "description": "\n

package: maximum version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_id", + "full_name": "errata_id", + "description": "\n

erratum: id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_ids", + "full_name": "errata_ids", + "description": "\n

erratum: IDs or a select all object

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "start_date", + "full_name": "start_date", + "description": "\n

erratum: start date (YYYY-MM-DD)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "end_date", + "full_name": "end_date", + "description": "\n

erratum: end date (YYYY-MM-DD)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "types", + "full_name": "types", + "description": "\n

erratum: types (enhancement, bugfix, security)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "date_type", + "full_name": "date_type", + "description": "\n

erratum: search using the 'Issued On' or 'Updated On'\ncolumn of the errata. Values are 'issued'/'updated'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "module_stream_ids", + "full_name": "module_stream_ids", + "description": "\n

module stream ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filter_rules/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/rules/:id", + "http_method": "GET", + "short_description": "Show filter rule info", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

rule identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filter_rules/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/rules/:id", + "http_method": "PUT", + "short_description": "Update a filter rule. The parameters included should be based upon the filter type.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

rule identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

package, package group, or docker tag: name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

package: version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture", + "full_name": "architecture", + "description": "\n

package: architecture

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "min_version", + "full_name": "min_version", + "description": "\n

package: minimum version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_version", + "full_name": "max_version", + "description": "\n

package: maximum version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_id", + "full_name": "errata_id", + "description": "\n

erratum: id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "start_date", + "full_name": "start_date", + "description": "\n

erratum: start date (YYYY-MM-DD)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "end_date", + "full_name": "end_date", + "description": "\n

erratum: end date (YYYY-MM-DD)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "types", + "full_name": "types", + "description": "\n

erratum: types (enhancement, bugfix, security)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filter_rules/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/rules/:id", + "http_method": "DELETE", + "short_description": "Delete a filter rule", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

rule identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "srpms": { + "doc_url": "../apidoc/v2/srpms", + "api_url": "/api", + "name": "Srpms", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/srpms/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/srpms", + "http_method": "GET", + "short_description": "List srpms", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

Content View Version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/srpms/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/srpms/:id", + "http_method": "GET", + "short_description": "Show SRPM details", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/srpms/:id", + "http_method": "GET", + "short_description": "Show SRPM details", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

SRPM details identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/srpms/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/srpms/compare", + "http_method": "GET", + "short_description": "List srpms", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "content_view_filters": { + "doc_url": "../apidoc/v2/content_view_filters", + "api_url": "/api", + "name": "Content view filters", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_view_filters/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/filters", + "http_method": "get", + "short_description": "list filters", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters", + "http_method": "get", + "short_description": "list filters", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

filter content view filters by name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "types", + "full_name": "types", + "description": "\n

types of filters

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "content_type", + "values": [ + "rpm", + "package_group", + "erratum", + "docker", + "modulemd" + ] + }, + { + "name": "inclusion_type", + "values": [ + "include", + "exclude" + ] + }, + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filters/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/filters", + "http_method": "post", + "short_description": "create a filter for a content view", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters", + "http_method": "post", + "short_description": "create a filter for a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the filter

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "type", + "full_name": "type", + "description": "\n

type of filter (e.g. rpm, package_group, erratum, docker, modulemd)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "original_packages", + "full_name": "original_packages", + "description": "\n

add all packages without errata to the included/excluded list. (package\nfilter only)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "inclusion", + "full_name": "inclusion", + "description": "\n

specifies if content should be included or excluded, default:\ninclusion=false

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_ids", + "full_name": "repository_ids", + "description": "\n

list of repository ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description of the filter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filters/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:id", + "http_method": "get", + "short_description": "show filter info", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:id", + "http_method": "get", + "short_description": "show filter info", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filters/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:id", + "http_method": "put", + "short_description": "update a filter", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:id", + "http_method": "put", + "short_description": "update a filter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

new name for the filter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "original_packages", + "full_name": "original_packages", + "description": "\n

add all packages without errata to the included/excluded list. (package\nfilter only)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "inclusion", + "full_name": "inclusion", + "description": "\n

specifies if content should be included or excluded, default:\ninclusion=false

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_ids", + "full_name": "repository_ids", + "description": "\n

list of repository ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description of the filter

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_filters/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:id", + "http_method": "delete", + "short_description": "delete a filter", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:id", + "http_method": "delete", + "short_description": "delete a filter", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

filter identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "content_view_histories": { + "doc_url": "../apidoc/v2/content_view_histories", + "api_url": "/api", + "name": "Content view histories", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_view_histories/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/history", + "http_method": "GET", + "short_description": "Show a content view's history", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "products": { + "doc_url": "../apidoc/v2/products", + "api_url": "/api", + "name": "Products", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/products/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/products", + "http_method": "GET", + "short_description": "List products", + "deprecated": null + }, + { + "api_url": "/katello/api/subscriptions/:subscription_id/products", + "http_method": "GET", + "short_description": "List of subscription products in a subscription", + "deprecated": null + }, + { + "api_url": "/katello/api/activation_keys/:activation_key_id/products", + "http_method": "GET", + "short_description": "List of subscription products in an activation key", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/products", + "http_method": "GET", + "short_description": "List of products in an organization", + "deprecated": null + }, + { + "api_url": "/katello/api/sync_plans/:sync_plan_id/products", + "http_method": "GET", + "short_description": "List of Products for sync plan", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products", + "http_method": "GET", + "short_description": "List of Products for sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Filter products by organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscription_id", + "full_name": "subscription_id", + "description": "\n

Filter products by subscription

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Filter products by name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "enabled", + "description": "\n

Return enabled products only

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "custom", + "full_name": "custom", + "description": "\n

Return custom products only

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "redhat_only", + "full_name": "redhat_only", + "description": "\n

Return Red Hat (non-custom) products only

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include_available_content", + "full_name": "include_available_content", + "description": "\n

Whether to include available content attribute in results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_plan_id", + "full_name": "sync_plan_id", + "description": "\n

Filter products by sync plan id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

Interpret specified object to return only Products that can be associated\nwith specified object. Only 'sync_plan' is supported.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "description", + "type": "text" + }, + { + "name": "label", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + }, + { + "name": "redhat", + "values": [ + "true", + "false" + ] + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/products", + "http_method": "POST", + "short_description": "Create a product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

Product description

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gpg_key_id", + "full_name": "gpg_key_id", + "description": "\n

Identifier of the GPG key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_ca_cert_id", + "full_name": "ssl_ca_cert_id", + "description": "\n

Idenifier of the SSL CA Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_cert_id", + "full_name": "ssl_client_cert_id", + "description": "\n

Identifier of the SSL Client Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_key_id", + "full_name": "ssl_client_key_id", + "description": "\n

Identifier of the SSL Client Key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_plan_id", + "full_name": "sync_plan_id", + "description": "\n

Plan numeric identifier

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Product name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/products/:id", + "http_method": "GET", + "short_description": "Show a product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

product numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/products/:id", + "http_method": "PUT", + "short_description": "Updates a product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

product numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

Product description

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "gpg_key_id", + "full_name": "gpg_key_id", + "description": "\n

Identifier of the GPG key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_ca_cert_id", + "full_name": "ssl_ca_cert_id", + "description": "\n

Idenifier of the SSL CA Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_cert_id", + "full_name": "ssl_client_cert_id", + "description": "\n

Identifier of the SSL Client Cert

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ssl_client_key_id", + "full_name": "ssl_client_key_id", + "description": "\n

Identifier of the SSL Client Key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_plan_id", + "full_name": "sync_plan_id", + "description": "\n

Plan numeric identifier

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Product name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/products/:id", + "http_method": "DELETE", + "short_description": "Destroy a product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

product numeric identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/products/sync", + "name": "sync", + "apis": [ + { + "api_url": "/katello/api/products/:id/sync", + "http_method": "POST", + "short_description": "Sync all repositories for a product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

product ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "content_view_puppet_modules": { + "doc_url": "../apidoc/v2/content_view_puppet_modules", + "api_url": "/api", + "name": "Content view puppet modules", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_view_puppet_modules/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/content_view_puppet_modules", + "http_method": "GET", + "short_description": "List content view puppet modules", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "author", + "full_name": "author", + "description": "\n

author of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "uuid", + "description": "\n

uuid of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "author", + "type": "string" + }, + { + "name": "content_view_name", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "uuid", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_puppet_modules/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/content_view_puppet_modules", + "http_method": "POST", + "short_description": "Add a puppet module to the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "author", + "full_name": "author", + "description": "\n

author of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

the id of the puppet module to associate

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "uuid", + "description": "\n

the uuid of the puppet module to associate

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_puppet_modules/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id", + "http_method": "GET", + "short_description": "Show a content view puppet module", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

puppet module ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_puppet_modules/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id", + "http_method": "PUT", + "short_description": "Update a puppet module associated with the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

puppet module ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "author", + "full_name": "author", + "description": "\n

author of the puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "uuid", + "full_name": "uuid", + "description": "\n

the uuid of the puppet module to associate

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_puppet_modules/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id", + "http_method": "DELETE", + "short_description": "Remove a puppet module from the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

puppet module ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "subscriptions": { + "doc_url": "../apidoc/v2/subscriptions", + "api_url": "/api", + "name": "Subscriptions", + "short_description": null, + "full_description": "\n

Subscriptions management.

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/subscriptions/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/subscriptions", + "http_method": "GET", + "short_description": "List organization subscriptions", + "deprecated": null + }, + { + "api_url": "/katello/api/activation_keys/:activation_key_id/subscriptions", + "http_method": "GET", + "short_description": "List an activation key's subscriptions", + "deprecated": null + }, + { + "api_url": "/katello/api/subscriptions", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

id of a host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "activation_key_id", + "full_name": "activation_key_id", + "description": "\n

Activation key ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

Object to show subscriptions available for, either 'host' or\n'activation_key'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "match_host", + "full_name": "match_host", + "description": "\n

Ignore subscriptions that are unavailable to the specified host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "match_installed", + "full_name": "match_installed", + "description": "\n

Return subscriptions that match installed products of the specified host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "no_overlap", + "full_name": "no_overlap", + "description": "\n

Return subscriptions which do not overlap with a currently-attached\nsubscription

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subscriptions/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/subscriptions/:id", + "http_method": "GET", + "short_description": "Show a subscription", + "deprecated": null + }, + { + "api_url": "/katello/api/subscriptions/:id", + "http_method": "GET", + "short_description": "Show a subscription", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Subscription identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subscriptions/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/activation_keys/:activation_key_id/subscriptions", + "http_method": "POST", + "short_description": "Add a subscription to an activation key", + "deprecated": true + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Subscription Pool uuid

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "activation_key_id", + "full_name": "activation_key_id", + "description": "\n

ID of the activation key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "quantity", + "description": "\n

Quantity of this subscriptions to add

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to add

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool uuid

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "subscriptions[quantity]", + "description": "\n

Quantity of this subscriptions to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subscriptions/upload", + "name": "upload", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/subscriptions/upload", + "http_method": "POST", + "short_description": "Upload a subscription manifest", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

Subscription manifest file

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "File", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_url", + "full_name": "repository_url", + "description": "\n

repository url

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subscriptions/refresh_manifest", + "name": "refresh_manifest", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/subscriptions/refresh_manifest", + "http_method": "PUT", + "short_description": "Refresh previously imported manifest for Red Hat provider", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subscriptions/delete_manifest", + "name": "delete_manifest", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/subscriptions/delete_manifest", + "http_method": "POST", + "short_description": "Delete manifest from Red Hat provider", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subscriptions/manifest_history", + "name": "manifest_history", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/subscriptions/manifest_history", + "http_method": "GET", + "short_description": "obtain manifest history for subscriptions", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "content_view_versions": { + "doc_url": "../apidoc/v2/content_view_versions", + "api_url": "/api", + "name": "Content view versions", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_view_versions/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/content_view_versions", + "http_method": "GET", + "short_description": "List content view versions", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/content_view_versions", + "http_method": "GET", + "short_description": "List content view versions", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

Content view identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Filter versions by environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_module_id", + "full_name": "puppet_module_id", + "description": "\n

Filter versions by puppet module

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "version", + "full_name": "version", + "description": "\n

Filter versions by version number

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "composite_version_id", + "full_name": "composite_version_id", + "description": "\n

Filter versions that are components in the specified composite version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "triggered_by_id", + "full_name": "triggered_by_id", + "description": "\n

Filter composite versions whose publish was triggered by the specified\ncomponent version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "content_view_id", + "type": "integer" + }, + { + "name": "repository", + "type": "string" + }, + { + "name": "version", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id", + "http_method": "GET", + "short_description": "Show content view version", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/promote", + "name": "promote", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id/promote", + "http_method": "POST", + "short_description": "Promote a content view version", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "force", + "full_name": "force", + "description": "\n

force content view promotion and bypass lifecycle environment restriction

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

LifeCycle Environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "environment_ids", + "description": "\n

Identifiers for Lifecycle Environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

The description for the content view version promotion

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id", + "http_method": "PUT", + "short_description": "Update a content view version", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

The description for the content view version

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/republish_repositories", + "name": "republish_repositories", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id/republish_repositories", + "http_method": "PUT", + "short_description": "Forces a republish of the version's repositories' metadata", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/export", + "name": "export", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id/export", + "http_method": "POST", + "short_description": "Export a content view version", + "deprecated": true + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "export_to_iso", + "full_name": "export_to_iso", + "description": "\n

Export to ISO format

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "iso_mb_size", + "full_name": "iso_mb_size", + "description": "\n

maximum size of each ISO in MB

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "since", + "full_name": "since", + "description": "\n

Optional date of last export (ex: 2010-01-01T12:00:00Z)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Date", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id", + "http_method": "DELETE", + "short_description": "Remove content view version", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_view_versions/incremental_update", + "name": "incremental_update", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/incremental_update", + "http_method": "POST", + "short_description": "Perform an Incremental Update on one or more Content View Versions", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_environments", + "full_name": "content_view_version_environments", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_view_version_id", + "full_name": "content_view_version_environments[content_view_version_id]", + "description": "\n

Content View Version Ids to perform an incremental update on. May contain\ncomposites as well as one or more components to update.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "content_view_version_environments[environment_ids]", + "description": "\n

The list of environments to promote the specified Content View Version to\n(replacing the older version)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

The description for the new generated Content View Versions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "resolve_dependencies", + "full_name": "resolve_dependencies", + "description": "\n

If true, when adding the specified errata or packages, any needed\ndependencies will be copied as well. Defaults to true

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "propagate_all_composites", + "full_name": "propagate_all_composites", + "description": "\n

If true, will publish a new composite version using any specified\ncontent_view_version_id that has been promoted to a lifecycle environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "add_content", + "full_name": "add_content", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "errata_ids", + "full_name": "add_content[errata_ids]", + "description": "\n

Errata ids to copy into the new versions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "package_ids", + "full_name": "add_content[package_ids]", + "description": "\n

Package ids to copy into the new versions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "deb_ids", + "full_name": "add_content[deb_ids]", + "description": "\n

Deb Package ids to copy into the new versions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_module_ids", + "full_name": "add_content[puppet_module_ids]", + "description": "\n

Puppet Module ids to copy into the new versions

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "update_hosts", + "full_name": "update_hosts", + "description": "\n

After generating the incremental update, apply the changes to the specified\nhosts. Only Errata are supported currently.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "included", + "full_name": "update_hosts[included]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "update_hosts[included][search]", + "description": "\n

Search string for host to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "update_hosts[included][ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "update_hosts[excluded]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "update_hosts[excluded][ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "content_views": { + "doc_url": "../apidoc/v2/content_views", + "api_url": "/api", + "name": "Content views", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/content_views/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/content_views", + "http_method": "GET", + "short_description": "List content views", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views", + "http_method": "GET", + "short_description": "List content views", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "nondefault", + "full_name": "nondefault", + "description": "\n

Filter out default content views

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "noncomposite", + "full_name": "noncomposite", + "description": "\n

Filter out composite content views

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "composite", + "full_name": "composite", + "description": "\n

Filter only composite content views

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "without", + "full_name": "without", + "description": "\n

Do not include this array of content views

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Name of the content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "composite", + "values": [ + "true", + "false" + ] + }, + { + "name": "label", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/content_views", + "http_method": "POST", + "short_description": "Create a content view", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views", + "http_method": "POST", + "short_description": "Create a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Name of the content view

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "\n

Content view label

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "composite", + "full_name": "composite", + "description": "\n

Composite content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

Description for the content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_ids", + "full_name": "repository_ids", + "description": "\n

List of repository ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "component_ids", + "full_name": "component_ids", + "description": "\n

List of component content view version ids for composite views

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auto_publish", + "full_name": "auto_publish", + "description": "\n

Enable/Disable auto publish of composite view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "solve_dependencies", + "full_name": "solve_dependencies", + "description": "\n

Solve RPM dependencies by default on Content View publish, defaults to\nfalse

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/content_views/:id", + "http_method": "PUT", + "short_description": "Update a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

New name for the content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

Description for the content view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_ids", + "full_name": "repository_ids", + "description": "\n

List of repository ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "component_ids", + "full_name": "component_ids", + "description": "\n

List of component content view version ids for composite views

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "auto_publish", + "full_name": "auto_publish", + "description": "\n

Enable/Disable auto publish of composite view

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "solve_dependencies", + "full_name": "solve_dependencies", + "description": "\n

Solve RPM dependencies by default on Content View publish, defaults to\nfalse

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/publish", + "name": "publish", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/publish", + "http_method": "POST", + "short_description": "Publish a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

Description for the new published content view version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "major", + "full_name": "major", + "description": "\n

Override the major version number

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "minor", + "full_name": "minor", + "description": "\n

Override the minor version number

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repos_units", + "full_name": "repos_units", + "description": "\n

Specify the list of units in each repo

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "label", + "full_name": "repos_units[label]", + "description": "\n

repo label

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "rpm_filenames", + "full_name": "repos_units[rpm_filenames]", + "description": "\n

list of rpm filename strings to include in published version

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of String", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/content_views/:id", + "http_method": "GET", + "short_description": "Show a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/available_puppet_modules", + "name": "available_puppet_modules", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/available_puppet_modules", + "http_method": "GET", + "short_description": "Get puppet modules that are available to be added to the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

module name to restrict modules for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/available_puppet_module_names", + "name": "available_puppet_module_names", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/available_puppet_module_names", + "http_method": "GET", + "short_description": "Get puppet modules names that are available to be added to the content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/remove_from_environment", + "name": "remove_from_environment", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/environments/:environment_id", + "http_method": "DELETE", + "short_description": "Remove a content view from an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/remove", + "name": "remove", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/remove", + "http_method": "PUT", + "short_description": "Remove versions and/or environments from a content view and reassign systems and keys", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_ids", + "full_name": "environment_ids", + "description": "\n

environment numeric identifiers to be removed

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view version identifiers to be deleted

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "system_content_view_id", + "full_name": "system_content_view_id", + "description": "\n

content view to reassign orphaned systems to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "system_environment_id", + "full_name": "system_environment_id", + "description": "\n

environment to reassign orphaned systems to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "key_content_view_id", + "full_name": "key_content_view_id", + "description": "\n

content view to reassign orphaned activation keys to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "key_environment_id", + "full_name": "key_environment_id", + "description": "\n

environment to reassign orphaned activation keys to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/content_views/:id", + "http_method": "DELETE", + "short_description": "Delete a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/content_views/copy", + "name": "copy", + "apis": [ + { + "api_url": "/katello/api/content_views/:id/copy", + "http_method": "POST", + "short_description": "Make copy of a content view", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content view numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

New content view name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "debs": { + "doc_url": "../apidoc/v2/debs", + "api_url": "/api", + "name": "Deb Packages", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/debs/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/debs", + "http_method": "GET", + "short_description": "List deb packages", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/debs", + "http_method": "GET", + "short_description": "List deb packages", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/debs", + "http_method": "GET", + "short_description": "List deb packages", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/debs", + "http_method": "GET", + "short_description": "List deb packages", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

Content View Version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

Content View Filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

Deb package identifiers to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host id to list applicable deb packages for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages_restrict_applicable", + "full_name": "packages_restrict_applicable", + "description": "\n

Return deb packages that are applicable to one or more hosts (defaults to\ntrue if host_id is specified)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages_restrict_upgradable", + "full_name": "packages_restrict_upgradable", + "description": "\n

Return deb packages that are upgradable on one or more hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages_restrict_latest", + "full_name": "packages_restrict_latest", + "description": "\n

Return only the latest version of each package

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

Return deb packages that can be added to the specified object. Only the\nvalue 'content_view_version' is supported.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/debs/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/debs/:id", + "http_method": "GET", + "short_description": "Show a deb package", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/debs/:id", + "http_method": "GET", + "short_description": "Show a deb package", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a deb package identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/debs/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/debs/compare", + "http_method": "GET", + "short_description": "List deb packages", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "docker_manifest_lists": { + "doc_url": "../apidoc/v2/docker_manifest_lists", + "api_url": "/api", + "name": "Docker manifest lists", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/docker_manifest_lists/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/docker_manifest_lists", + "http_method": "GET", + "short_description": "List docker_manifest_lists", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists", + "http_method": "GET", + "short_description": "List docker_manifest_lists", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists", + "http_method": "GET", + "short_description": "List docker_manifest_lists", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/docker_manifest_lists", + "http_method": "GET", + "short_description": "List docker_manifest_lists", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/docker_manifest_lists/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/docker_manifest_lists/:id", + "http_method": "GET", + "short_description": "Show a docker manifest list", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/docker_manifest_lists/:id", + "http_method": "GET", + "short_description": "Show a docker manifest list", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a docker manifest list identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/docker_manifest_lists/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/docker_manifest_lists/compare", + "http_method": "GET", + "short_description": "List docker_manifest_lists", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "docker_manifests": { + "doc_url": "../apidoc/v2/docker_manifests", + "api_url": "/api", + "name": "Docker manifests", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/docker_manifests/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/docker_manifests", + "http_method": "GET", + "short_description": "List docker_manifests", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests", + "http_method": "GET", + "short_description": "List docker_manifests", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/docker_manifests", + "http_method": "GET", + "short_description": "List docker_manifests", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/docker_manifests", + "http_method": "GET", + "short_description": "List docker_manifests", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/docker_manifests/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/docker_manifests/:id", + "http_method": "GET", + "short_description": "Show a docker manifest", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/docker_manifests/:id", + "http_method": "GET", + "short_description": "Show a docker manifest", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a docker manifest identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/docker_manifests/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/docker_manifests/compare", + "http_method": "GET", + "short_description": "List docker_manifests", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "docker_tags": { + "doc_url": "../apidoc/v2/docker_tags", + "api_url": "/api", + "name": "Docker tags", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/docker_tags/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/docker_tags", + "http_method": "GET", + "short_description": "List docker_tags", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags", + "http_method": "GET", + "short_description": "List docker_tags", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/docker_tags", + "http_method": "GET", + "short_description": "List docker_tags", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/docker_tags", + "http_method": "GET", + "short_description": "List docker_tags", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/docker_tags/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/docker_tags/:id", + "http_method": "GET", + "short_description": "Show a docker tag", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/docker_tags/:id", + "http_method": "GET", + "short_description": "Show a docker tag", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a docker tag identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/docker_tags/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/docker_tags/compare", + "http_method": "GET", + "short_description": "List docker_tags", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "lifecycle_environments": { + "doc_url": "../apidoc/v2/lifecycle_environments", + "api_url": "/api", + "name": "Lifecycle environments", + "short_description": null, + "full_description": "\n

# Description

\n\n

An environment is a basic organization structure that groups hosts,\nproducts, repositories, etc. Every host belongs to one environment and\nit's isolated inside so that it can see only content that is in its\nenvironment.

\n\n

## Chains

\n\n

Environments are ordered into chains and their content (products,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:

\n\n
Library -> Development -> Testing -> Production
\n\n

Each change in an environment is done through a changeset in an action\ncalled promotion.

\n\n

## Library

\n\n

Library is a special environment that has no ascendant: All the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/lifecycle_environments/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/environments", + "http_method": "GET", + "short_description": "List environments in an organization", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/environments", + "http_method": "GET", + "short_description": "List environments in an organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "library", + "full_name": "library", + "description": "\n

set true if you want to see only library environments

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

filter only environments containing this name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/lifecycle_environments/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/environments/:id", + "http_method": "GET", + "short_description": "Show an environment", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/environments/:environment_id", + "http_method": "GET", + "short_description": "Show an environment", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the environment

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/lifecycle_environments/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/environments", + "http_method": "POST", + "short_description": "Create an environment", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/environments", + "http_method": "POST", + "short_description": "Create an environment in an organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

name of organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the environment

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "label", + "full_name": "label", + "description": "\n

label of the environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description of the environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "registry_name_pattern", + "full_name": "registry_name_pattern", + "description": "\n

pattern for container image names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "registry_unauthenticated_pull", + "full_name": "registry_unauthenticated_pull", + "description": "\n

allow unauthenticed pull of container images

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "prior_id", + "full_name": "prior_id", + "description": "\n

ID of an environment that is prior to the new environment in the chain. It\nhas to be either the ID of Library or the ID of an environment at the end\nof a chain.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/lifecycle_environments/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/environments/:id", + "http_method": "PUT", + "short_description": "Update an environment", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/environments/:id", + "http_method": "PUT", + "short_description": "Update an environment in an organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the environment

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

name of the organization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "new_name", + "full_name": "new_name", + "description": "\n

new name to be given to the environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

description of the environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "registry_name_pattern", + "full_name": "registry_name_pattern", + "description": "\n

pattern for container image names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "registry_unauthenticated_pull", + "full_name": "registry_unauthenticated_pull", + "description": "\n

allow unauthenticed pull of container images

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "async", + "full_name": "async", + "description": "\n

Do not wait for the update action to finish. Default: true

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/lifecycle_environments/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/environments/:id", + "http_method": "DELETE", + "short_description": "Destroy an environment", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/environments/:id", + "http_method": "DELETE", + "short_description": "Destroy an environment in an organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the environment

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/lifecycle_environments/paths", + "name": "paths", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/environments/paths", + "http_method": "GET", + "short_description": "List environment paths", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "permission_type", + "full_name": "permission_type", + "description": "\n

The associated permission type. One of (readable | promotable) Default:\nreadable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "errata": { + "doc_url": "../apidoc/v2/errata", + "api_url": "/api", + "name": "Errata", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/errata/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/errata", + "http_method": "GET", + "short_description": "List errata", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

Content View Version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

Content View Filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cve", + "full_name": "cve", + "description": "\n

CVE identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host id to list applicable errata for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_restrict_applicable", + "full_name": "errata_restrict_applicable", + "description": "\n

Return errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_restrict_installable", + "full_name": "errata_restrict_installable", + "description": "\n

Return errata that are upgradable on one or more hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

Return errata that can be added to the specified object. The values\n'content_view_version' and 'content_view_filter are supported.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "bug", + "type": "string" + }, + { + "name": "cve", + "type": "string" + }, + { + "name": "errata_id", + "type": "string" + }, + { + "name": "errata_type", + "type": "string" + }, + { + "name": "id", + "type": "string" + }, + { + "name": "issued", + "type": "date" + }, + { + "name": "modular", + "values": [ + "true", + "false" + ] + }, + { + "name": "package", + "type": "string" + }, + { + "name": "package_name", + "type": "string" + }, + { + "name": "reboot_suggested", + "type": "boolean" + }, + { + "name": "repository", + "type": "string" + }, + { + "name": "severity", + "type": "string" + }, + { + "name": "title", + "type": "string" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "updated", + "type": "date" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/errata/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/errata/:id", + "http_method": "GET", + "short_description": "Show an erratum", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/errata/:id", + "http_method": "GET", + "short_description": "Show an erratum", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

an erratum identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/errata/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/errata/compare", + "http_method": "GET", + "short_description": "List errata", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/errata/available_errata", + "name": "available_errata", + "apis": [ + { + "api_url": "/katello/api/content_view_versions/:id/available_errata", + "http_method": "GET", + "short_description": "Return errata that can be added to the Content View Version via an Incremental Update", + "deprecated": true + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Content View Version identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

Content View Filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cve", + "full_name": "cve", + "description": "\n

CVE identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host id to list applicable errata for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_restrict_applicable", + "full_name": "errata_restrict_applicable", + "description": "\n

Return errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_restrict_installable", + "full_name": "errata_restrict_installable", + "description": "\n

Return errata that are upgradable on one or more hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "file_units": { + "doc_url": "../apidoc/v2/file_units", + "api_url": "/api", + "name": "Files", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/file_units/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/files", + "http_method": "GET", + "short_description": "List files", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/files", + "http_method": "GET", + "short_description": "List files", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/files", + "http_method": "GET", + "short_description": "List files", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/files", + "http_method": "GET", + "short_description": "List files", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/file_units/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/files/:id", + "http_method": "GET", + "short_description": "Show a file", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/files/:id", + "http_method": "GET", + "short_description": "Show a file", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a file identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/file_units/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/files/compare", + "http_method": "GET", + "short_description": "List :resource", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "gpg_keys": { + "doc_url": "../apidoc/v2/gpg_keys", + "api_url": "/api", + "name": "Gpg keys", + "short_description": null, + "full_description": "\n

# Description Documents the calls for the list, read, create, update and\ndelete operations for GPG keys

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/gpg_keys/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/gpg_keys", + "http_method": "GET", + "short_description": "List gpg keys", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

name of the GPG key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/gpg_keys/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/gpg_keys", + "http_method": "POST", + "short_description": "Create a gpg key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

identifier of the gpg key

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

public key block in DER encoding

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/gpg_keys/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/gpg_keys/:id", + "http_method": "GET", + "short_description": "Show a gpg key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

gpg key numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/gpg_keys/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/gpg_keys/:id", + "http_method": "PUT", + "short_description": "Update a repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

gpg key numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

identifier of the gpg key

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

public key block in DER encoding

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/gpg_keys/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/gpg_keys/:id", + "http_method": "DELETE", + "short_description": "Destroy a gpg key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

gpg key numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/gpg_keys/content", + "name": "content", + "apis": [ + { + "api_url": "/katello/api/gpg_keys/:id/content", + "http_method": "GET", + "short_description": "Return the content of a gpg key, used directly by yum", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/gpg_keys/set_content", + "name": "set_content", + "apis": [ + { + "api_url": "/katello/api/gpg_keys/:id/content", + "http_method": "POST", + "short_description": "Upload gpg key contents", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

gpg key numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

file contents

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "File", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "host_collections": { + "doc_url": "../apidoc/v2/host_collections", + "api_url": "/api", + "name": "Host collections", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_collections/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/host_collections/:id", + "http_method": "GET", + "short_description": "Show a host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the host collection

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/host_collections", + "http_method": "GET", + "short_description": "List host collections", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/host_collections", + "http_method": "GET", + "short_description": "List host collections within an organization", + "deprecated": null + }, + { + "api_url": "/katello/api/activation_keys/:activation_key_id/host_collections", + "http_method": "GET", + "short_description": "List host collections in an activation key", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

host collection name to filter by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "activation_key_id", + "full_name": "activation_key_id", + "description": "\n

activation key identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Filter products by host id

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "available_for", + "full_name": "available_for", + "description": "\n

Interpret specified object to return only Host Collections that can be\nassociated with specified object. The value 'host' is supported.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "host", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/host_collections", + "http_method": "POST", + "short_description": "Create a host collection", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/host_collections", + "http_method": "POST", + "short_description": "Create a host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Host Collection name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

List of host ids to replace the hosts in host collection

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_hosts", + "full_name": "max_hosts", + "description": "\n

Maximum number of hosts in the host collection

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "unlimited_hosts", + "full_name": "unlimited_hosts", + "description": "\n

Whether or not the host collection may have unlimited hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/host_collections/:id", + "http_method": "PUT", + "short_description": "Update a host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the host collection

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

Host Collection name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

List of host ids to replace the hosts in host collection

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_hosts", + "full_name": "max_hosts", + "description": "\n

Maximum number of hosts in the host collection

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "unlimited_hosts", + "full_name": "unlimited_hosts", + "description": "\n

Whether or not the host collection may have unlimited hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/add_hosts", + "name": "add_hosts", + "apis": [ + { + "api_url": "/katello/api/host_collections/:id/add_hosts", + "http_method": "PUT", + "short_description": "Add host to the host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the host collection

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

Array of host ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/remove_hosts", + "name": "remove_hosts", + "apis": [ + { + "api_url": "/katello/api/host_collections/:id/remove_hosts", + "http_method": "PUT", + "short_description": "Remove hosts from the host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the host collection

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

Array of host ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/host_collections/:id", + "http_method": "DELETE", + "short_description": "Destroy a host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

Id of the host collection

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_collections/copy", + "name": "copy", + "apis": [ + { + "api_url": "/katello/api/host_collections/:id/copy", + "http_method": "POST", + "short_description": "Make copy of a host collection", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the host collection

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

New host collection name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "host_debs": { + "doc_url": "../apidoc/v2/host_debs", + "api_url": "/api", + "name": "Host debs", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_debs/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/debs", + "http_method": "GET", + "short_description": "List deb packages installed on the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "host_errata": { + "doc_url": "../apidoc/v2/host_errata", + "api_url": "/api", + "name": "Host errata", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_errata/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/errata", + "http_method": "GET", + "short_description": "List errata available for the content host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

UUID of the content host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "\n

Calculate Applicable Errata based on a particular Content View

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

Calculate Applicable Errata based on a particular Environment

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_errata/apply", + "name": "apply", + "apis": [ + { + "api_url": "/api/hosts/:host_id/errata/apply", + "http_method": "PUT", + "short_description": "Schedule errata for installation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "errata_ids", + "full_name": "errata_ids", + "description": "\n

List of Errata ids to install

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "\n

Errata to exclusively include in the action

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for erratum to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of errata ids to perform an action on, (ex: RHSA-2019:1168)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "\n

Errata to explicitly exclude in the action. All other applicable errata\nwill be included in the action, unless an included parameter is passed as\nwell.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of errata ids to exclude and not run an action on, (ex:\nRHSA-2019:1168)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_errata/show", + "name": "show", + "apis": [ + { + "api_url": "/api/hosts/:host_id/errata/:id", + "http_method": "GET", + "short_description": "Retrieve a single errata for a host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Errata id of the erratum (RHSA-2012:108)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_errata/applicability", + "name": "applicability", + "apis": [ + { + "api_url": "/api/hosts/:host_id/errata/applicability", + "http_method": "PUT", + "short_description": "Force regenerate applicability.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

Host ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "host_module_streams": { + "doc_url": "../apidoc/v2/host_module_streams", + "api_url": "/api", + "name": "Host module streams", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_module_streams/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/module_streams", + "http_method": "GET", + "short_description": "List module streams available to the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "status", + "full_name": "status", + "description": "\n

Streams based on the host based on their status

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: enabled, disabled, unknown, installed, upgradable.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "host_packages": { + "doc_url": "../apidoc/v2/host_packages", + "api_url": "/api", + "name": "Host packages", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_packages/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/packages", + "http_method": "GET", + "short_description": "List packages installed on the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + }, + { + "name": "nvra", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_packages/install", + "name": "install", + "apis": [ + { + "api_url": "/api/hosts/:host_id/packages/install", + "http_method": "PUT", + "short_description": "Install packages remotely", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages", + "full_name": "packages", + "description": "\n

List of package names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "groups", + "full_name": "groups", + "description": "\n

List of package group names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_packages/upgrade", + "name": "upgrade", + "apis": [ + { + "api_url": "/api/hosts/:host_id/packages/upgrade", + "http_method": "PUT", + "short_description": "Update packages remotely", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages", + "full_name": "packages", + "description": "\n

list of packages names

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_packages/upgrade_all", + "name": "upgrade_all", + "apis": [ + { + "api_url": "/api/hosts/:host_id/packages/upgrade_all", + "http_method": "PUT", + "short_description": "Update packages remotely", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/host_packages/remove", + "name": "remove", + "apis": [ + { + "api_url": "/api/hosts/:host_id/packages/remove", + "http_method": "PUT", + "short_description": "Uninstall packages remotely", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "packages", + "full_name": "packages", + "description": "\n

List of package names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "groups", + "full_name": "groups", + "description": "\n

List of package group names

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "host_tracer": { + "doc_url": "../apidoc/v2/host_tracer", + "api_url": "/api", + "name": "Host tracer", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/host_tracer/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/traces", + "http_method": "GET", + "short_description": "List services that need restarting on the host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "host_id", + "full_name": "host_id", + "description": "\n

ID of the host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "hosts_bulk_actions": { + "doc_url": "../apidoc/v2/hosts_bulk_actions", + "api_url": "/api", + "name": "Hosts bulk actions", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections", + "name": "bulk_add_host_collections", + "apis": [ + { + "api_url": "/api/hosts/bulk/add_host_collections", + "http_method": "PUT", + "short_description": "Add one or more host collections to one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "host_collection_ids", + "full_name": "host_collection_ids", + "description": "\n

List of host collection ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections", + "name": "bulk_remove_host_collections", + "apis": [ + { + "api_url": "/api/hosts/bulk/remove_host_collections", + "http_method": "PUT", + "short_description": "Remove one or more host collections from one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "host_collection_ids", + "full_name": "host_collection_ids", + "description": "\n

List of host collection ids

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/applicable_errata", + "name": "applicable_errata", + "apis": [ + { + "api_url": "/api/hosts/bulk/applicable_errata", + "http_method": "POST", + "short_description": "Fetch applicable errata for a host.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/installable_errata", + "name": "installable_errata", + "apis": [ + { + "api_url": "/api/hosts/bulk/installable_errata", + "http_method": "POST", + "short_description": "Fetch installable errata for a host.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/install_content", + "name": "install_content", + "apis": [ + { + "api_url": "/api/hosts/bulk/install_content", + "http_method": "PUT", + "short_description": "Install content on one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

The type of content. The following types are supported: 'package',\n'package_group' and 'errata'.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

List of content (e.g. package names, package group names or errata ids)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/update_content", + "name": "update_content", + "apis": [ + { + "api_url": "/api/hosts/bulk/update_content", + "http_method": "PUT", + "short_description": "Update content on one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

The type of content. The following types are supported: 'package'\nand 'package_group.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

List of content (e.g. package or package group names)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "update_all", + "full_name": "update_all", + "description": "\n

Updates all packages on the host(s)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/remove_content", + "name": "remove_content", + "apis": [ + { + "api_url": "/api/hosts/bulk/remove_content", + "http_method": "PUT", + "short_description": "Remove content on one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "content_type", + "full_name": "content_type", + "description": "\n

The type of content. The following types are supported: 'package'\nand 'package_group.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content", + "full_name": "content", + "description": "\n

List of content (e.g. package or package group names)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/destroy_hosts", + "name": "destroy_hosts", + "apis": [ + { + "api_url": "/api/hosts/bulk/destroy", + "http_method": "PUT", + "short_description": "Destroy one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/remove_subscriptions", + "name": "remove_subscriptions", + "apis": [ + { + "api_url": "/api/hosts/bulk/remove_subscriptions", + "http_method": "PUT", + "short_description": "Remove subscriptions from one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to remove

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "subscriptions[quantity]", + "description": "\n

Quantity of specified subscription to remove

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/add_subscriptions", + "name": "add_subscriptions", + "apis": [ + { + "api_url": "/api/hosts/bulk/add_subscriptions", + "http_method": "PUT", + "short_description": "Add subscriptions to one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "subscriptions", + "full_name": "subscriptions", + "description": "\n

Array of subscriptions to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "subscriptions[id]", + "description": "\n

Subscription Pool id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "subscriptions[quantity]", + "description": "\n

Quantity of this subscriptions to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/auto_attach", + "name": "auto_attach", + "apis": [ + { + "api_url": "/api/hosts/bulk/auto_attach", + "http_method": "PUT", + "short_description": "Trigger an auto-attach of subscriptions on one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/content_overrides", + "name": "content_overrides", + "apis": [ + { + "api_url": "/api/hosts/bulk/content_overrides", + "http_method": "PUT", + "short_description": "Set content overrides to one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "content_overrides", + "full_name": "content_overrides", + "description": "\n

Array of Content override parameters

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "content_label", + "full_name": "content_overrides[content_label]", + "description": "\n

Label of the content

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "content_overrides[value]", + "description": "\n

Override value. Provide a boolean value if name is 'enabled'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "content_overrides[name]", + "description": "\n

Override key or name. Note if name is not provided the default name will be\n'enabled'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "remove", + "full_name": "content_overrides[remove]", + "description": "\n

Set true to remove an override and reset it to 'default'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/environment_content_view", + "name": "environment_content_view", + "apis": [ + { + "api_url": "/api/hosts/bulk/environment_content_view", + "http_method": "PUT", + "short_description": "Assign the environment and content view to one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_id", + "full_name": "content_view_id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/release_version", + "name": "release_version", + "apis": [ + { + "api_url": "/api/hosts/bulk/release_version", + "http_method": "PUT", + "short_description": "Assign the release version to one or more hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "release_version", + "full_name": "release_version", + "description": "\n

content release version

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/available_incremental_updates", + "name": "available_incremental_updates", + "apis": [ + { + "api_url": "/api/hosts/bulk/available_incremental_updates", + "http_method": "POST", + "short_description": "Given a set of hosts and errata, lists the content view versions and environments that need updating.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "errata_ids", + "full_name": "errata_ids", + "description": "\n

List of Errata ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/hosts_bulk_actions/module_streams", + "name": "module_streams", + "apis": [ + { + "api_url": "/api/hosts/bulk/module_streams", + "http_method": "POST", + "short_description": "Fetch available module streams for hosts.", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

ID of the organization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "included", + "full_name": "included", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "search", + "full_name": "included[search]", + "description": "\n

Search string for hosts to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "included[ids]", + "description": "\n

List of host ids to perform an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "excluded", + "full_name": "excluded", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "ids", + "full_name": "excluded[ids]", + "description": "\n

List of host ids to exclude and not run an action on

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "module_streams": { + "doc_url": "../apidoc/v2/module_streams", + "api_url": "/api", + "name": "Module streams", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/module_streams/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/module_streams", + "http_method": "GET", + "short_description": "List module_streams", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams", + "http_method": "GET", + "short_description": "List module_streams", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/module_streams", + "http_method": "GET", + "short_description": "List module_streams", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/module_streams", + "http_method": "GET", + "short_description": "List module_streams", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

List of host id to list available module streams for

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name_stream_only", + "full_name": "name_stream_only", + "description": "\n

Return name and stream information only)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/module_streams/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/module_streams/:id", + "http_method": "GET", + "short_description": "Show a module stream", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/module_streams/:id", + "http_method": "GET", + "short_description": "Show a module stream", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a module stream identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/module_streams/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/module_streams/compare", + "http_method": "GET", + "short_description": "List module_streams", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "ostree_branches": { + "doc_url": "../apidoc/v2/ostree_branches", + "api_url": "/api", + "name": "Ostree branches", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ostree_branches/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/ostree_branches", + "http_method": "GET", + "short_description": "List ostree_branches", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches", + "http_method": "GET", + "short_description": "List ostree_branches", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/ostree_branches", + "http_method": "GET", + "short_description": "List ostree_branches", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/ostree_branches", + "http_method": "GET", + "short_description": "List ostree_branches", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ostree_branches/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/ostree_branches/:id", + "http_method": "GET", + "short_description": "Show an ostree branch", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/ostree_branches/:id", + "http_method": "GET", + "short_description": "Show an ostree branch", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

an ostree branch identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ostree_branches/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/ostree_branches/compare", + "http_method": "GET", + "short_description": "List ostree_branches", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "package_groups": { + "doc_url": "../apidoc/v2/package_groups", + "api_url": "/api", + "name": "Package groups", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/package_groups/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/package_groups", + "http_method": "GET", + "short_description": "List package_groups", + "deprecated": null + }, + { + "api_url": "/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups", + "http_method": "GET", + "short_description": "List package_groups", + "deprecated": null + }, + { + "api_url": "/katello/api/content_view_filters/:content_view_filter_id/package_groups", + "http_method": "GET", + "short_description": "List package_groups", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/package_groups", + "http_method": "GET", + "short_description": "List package_groups", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

organization identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_version_id", + "full_name": "content_view_version_id", + "description": "\n

content view version identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_id", + "full_name": "content_view_filter_id", + "description": "\n

content view filter identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "content_view_filter_rule_id", + "full_name": "content_view_filter_rule_id", + "description": "\n

content view filter rule identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "environment_id", + "description": "\n

environment identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ids", + "full_name": "ids", + "description": "\n

ids to filter content by

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/package_groups/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/package_groups/:id", + "http_method": "GET", + "short_description": "Show a package group", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/package_groups/:id", + "http_method": "GET", + "short_description": "Show a package group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

a package group identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/package_groups/compare", + "name": "compare", + "apis": [ + { + "api_url": "/katello/api/package_groups/compare", + "http_method": "GET", + "short_description": "List package_groups", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "content_view_version_ids", + "full_name": "content_view_version_ids", + "description": "\n

content view versions to compare

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

Library repository id to restrict comparisons to

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/package_groups/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/package_group", + "http_method": "POST", + "short_description": "Create a package group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository_id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

package group name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

package group description. Defaults to params

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "user_visible", + "full_name": "user_visible", + "description": "\n

set \u201cuser_visible\u201d flag on package group. Defaults to true

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mandatory_package_names", + "full_name": "mandatory_package_names", + "description": "\n

mandatory package names to include in the package group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "optional_package_names", + "full_name": "optional_package_names", + "description": "\n

optional package names to include in the package group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "conditional_package_names", + "full_name": "conditional_package_names", + "description": "\n

conditional package names to include in the package group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_package_names", + "full_name": "default_package_names", + "description": "\n

default package names to include in the package group

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/package_groups/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/package_group", + "http_method": "DELETE", + "short_description": "Delete a package group", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "name", + "full_name": "name", + "description": "\n

package group name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repository_id", + "full_name": "repository_id", + "description": "\n

repository_id

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "sync": { + "doc_url": "../apidoc/v2/sync", + "api_url": "/api", + "name": "Sync", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/sync/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/products/:product_id/sync", + "http_method": "GET", + "short_description": "Get status of repo synchronisation for given product", + "deprecated": null + }, + { + "api_url": "/katello/api/repositories/:repository_id/sync", + "http_method": "GET", + "short_description": "Get status of synchronisation for given repository", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "sync_plans": { + "doc_url": "../apidoc/v2/sync_plans", + "api_url": "/api", + "name": "Sync plans", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/sync_plans/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/sync_plans", + "http_method": "GET", + "short_description": "List sync plans", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans", + "http_method": "GET", + "short_description": null, + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

filter by name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_date", + "full_name": "sync_date", + "description": "\n

filter by sync date

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "interval", + "description": "\n

filter by interval

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: hourly, daily, weekly, custom cron.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

Search string

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. 'id DESC'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full_result", + "full_name": "full_result", + "description": "\n

Whether or not to show all results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

Field to sort the results on

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_order", + "full_name": "sort_order", + "description": "\n

How to order the sorted results (e.g. ASC for ascending)

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "enabled", + "values": [ + "true", + "false" + ] + }, + { + "name": "interval", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "organization_id", + "type": "integer" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/show", + "name": "show", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:id", + "http_method": "GET", + "short_description": "Show a sync plan", + "deprecated": null + }, + { + "api_url": "/katello/api/sync_plans/:id", + "http_method": "GET", + "short_description": "Show a sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

sync plan numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans", + "http_method": "POST", + "short_description": "Create a sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

sync plan name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "interval", + "description": "\n

how often synchronization should run

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: hourly, daily, weekly, custom cron.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_date", + "full_name": "sync_date", + "description": "\n

start datetime of synchronization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

sync plan description

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "enabled", + "description": "\n

enables or disables synchronization

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cron_expression", + "full_name": "cron_expression", + "description": "\n

Add custom cron logic for sync plan

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:id", + "http_method": "PUT", + "short_description": "Update a sync plan", + "deprecated": null + }, + { + "api_url": "/katello/api/sync_plans/:id", + "http_method": "PUT", + "short_description": "Update a sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

sync plan numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "name", + "description": "\n

sync plan name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "interval", + "description": "\n

how often synchronization should run

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: hourly, daily, weekly, custom cron.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_date", + "full_name": "sync_date", + "description": "\n

start datetime of synchronization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "description", + "description": "\n

sync plan description

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "enabled", + "description": "\n

enables or disables synchronization

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "cron_expression", + "full_name": "cron_expression", + "description": "\n

Add custom cron logic for sync plan

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:id", + "http_method": "DELETE", + "short_description": "Destroy a sync plan", + "deprecated": null + }, + { + "api_url": "/katello/api/sync_plans/:id", + "http_method": "DELETE", + "short_description": "Destroy a sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

sync plan numeric identifier

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/add_products", + "name": "add_products", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:id/add_products", + "http_method": "PUT", + "short_description": "Add products to sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the sync plan

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_ids", + "full_name": "product_ids", + "description": "\n

List of product ids to add to the sync plan

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/remove_products", + "name": "remove_products", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:id/remove_products", + "http_method": "PUT", + "short_description": "Remove products from sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the sync plan

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "product_ids", + "full_name": "product_ids", + "description": "\n

List of product ids to remove from the sync plan

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/sync_plans/sync", + "name": "sync", + "apis": [ + { + "api_url": "/katello/api/sync_plans/:id/sync", + "http_method": "PUT", + "short_description": "Initiate a sync of the products attached to the sync plan", + "deprecated": null + }, + { + "api_url": "/katello/api/organizations/:organization_id/sync_plans/:id/sync", + "http_method": "PUT", + "short_description": "Initiate a sync of the products attached to the sync plan", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "id", + "full_name": "id", + "description": "\n

ID of the sync plan

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "upstream_subscriptions": { + "doc_url": "../apidoc/v2/upstream_subscriptions", + "api_url": "/api", + "name": "Upstream subscriptions", + "short_description": null, + "full_description": "\n

Red Hat subscriptions management platform.

\n", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/upstream_subscriptions/index", + "name": "index", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/upstream_subscriptions", + "http_method": "GET", + "short_description": "List available subscriptions from Red Hat Subscription Management", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

The order to sort the results in. ['asc', 'desc'] Defaults\nto 'desc'.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sort_by", + "full_name": "sort_by", + "description": "\n

The field to sort the data by. Defaults to the created date.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pool_ids", + "full_name": "pool_ids", + "description": "\n

Return only the upstream pools which map to the given foreman pool IDs

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantities_only", + "full_name": "quantities_only", + "description": "\n

Only returns id and quantity fields

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "attachable", + "full_name": "attachable", + "description": "\n

Return only subscriptions which can be attached to the upstream allocation

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/upstream_subscriptions/update", + "name": "update", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/upstream_subscriptions", + "http_method": "PUT", + "short_description": "Update the quantity of one or more subscriptions on an upstream allocation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pools", + "full_name": "pools", + "description": "\n

Array of Pools to be updated. Only pools originating upstream are accepted.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "pools[id]", + "description": "\n

foreman ID of local pool to update

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "pools[quantity]", + "description": "\n

Desired quantity of the pool

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/upstream_subscriptions/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/upstream_subscriptions", + "http_method": "DELETE", + "short_description": "Remove one or more subscriptions from an upstream subscription allocation", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pool_ids", + "full_name": "pool_ids", + "description": "\n

Array of local pool IDs. Only pools originating upstream are accepted.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/upstream_subscriptions/create", + "name": "create", + "apis": [ + { + "api_url": "/katello/api/organizations/:organization_id/upstream_subscriptions", + "http_method": "POST", + "short_description": "Add subscriptions consumed by a manifest from Red Hat Subscription Management", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "pools", + "full_name": "pools", + "description": "\n

Array of pools to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an Array of nested elements", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "id", + "full_name": "pools[id]", + "description": "\n

Candlepin ID of pool to add

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "quantity", + "full_name": "pools[quantity]", + "description": "\n

Quantity of entitlements to bind

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Organization ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "scc_accounts": { + "doc_url": "../apidoc/v2/scc_accounts", + "api_url": "/api", + "name": "Scc accounts", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/scc_accounts/index", + "name": "index", + "apis": [ + { + "api_url": "/api/v2/scc_accounts", + "http_method": "GET", + "short_description": "List all scc_accounts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/show", + "name": "show", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:id", + "http_method": "GET", + "short_description": "Show scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/create", + "name": "create", + "apis": [ + { + "api_url": "/api/v2/scc_accounts", + "http_method": "POST", + "short_description": "Create an scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "scc_account", + "full_name": "scc_account", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "organization_id", + "full_name": "scc_account[organization_id]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "scc_account[name]", + "description": "\n

Name of the scc_account

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "login", + "full_name": "scc_account[login]", + "description": "\n

Login id of scc_account

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "scc_account[password]", + "description": "\n

Password of scc_account

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "base_url", + "full_name": "scc_account[base_url]", + "description": "\n

URL of SUSE for scc_account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "scc_account[interval]", + "description": "\n

Interval for syncing scc_account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: never, daily, weekly, monthy.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_date", + "full_name": "scc_account[sync_date]", + "description": "\n

Last Sync time of scc_account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/update", + "name": "update", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:id", + "http_method": "PUT", + "short_description": "Update scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "scc_account", + "full_name": "scc_account", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "organization_id", + "full_name": "scc_account[organization_id]", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "name", + "full_name": "scc_account[name]", + "description": "\n

Name of the scc_account

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "login", + "full_name": "scc_account[login]", + "description": "\n

Login id of scc_account

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "scc_account[password]", + "description": "\n

Password of scc_account

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "base_url", + "full_name": "scc_account[base_url]", + "description": "\n

URL of SUSE for scc_account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "scc_account[interval]", + "description": "\n

Interval for syncing scc_account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: never, daily, weekly, monthy.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sync_date", + "full_name": "scc_account[sync_date]", + "description": "\n

Last Sync time of scc_account

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:id", + "http_method": "DELETE", + "short_description": "Delete scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/test_connection", + "name": "test_connection", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/test_connection", + "http_method": "POST", + "short_description": "Test connection for scc_account", + "deprecated": null + }, + { + "api_url": "/api/v2/scc_accounts/:id/test_connection", + "http_method": "PUT", + "short_description": "Test connection for scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "login", + "full_name": "login", + "description": "\n

Login id of scc_account

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "password", + "full_name": "password", + "description": "\n

Password of scc_account

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "base_url", + "full_name": "base_url", + "description": "\n

URL of SUSE for scc_account

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/sync", + "name": "sync", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:id/sync", + "http_method": "PUT", + "short_description": "Sync scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_accounts/bulk_subscribe", + "name": "bulk_subscribe", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:id/bulk_subscribe", + "http_method": "PUT", + "short_description": "Bulk subscription of scc_products for scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "scc_subscribe_product_ids", + "full_name": "scc_subscribe_product_ids", + "description": "", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "scc_products": { + "doc_url": "../apidoc/v2/scc_products", + "api_url": "/api", + "name": "Scc products", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/scc_products/index", + "name": "index", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:scc_account_id/scc_products", + "http_method": "GET", + "short_description": "List all products for scc_account", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "scc_account_id", + "full_name": "scc_account_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_products/show", + "name": "show", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:scc_account_id/scc_products/:id", + "http_method": "GET", + "short_description": "Show an scc_account product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "scc_account_id", + "full_name": "scc_account_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/scc_products/subscribe", + "name": "subscribe", + "apis": [ + { + "api_url": "/api/v2/scc_accounts/:scc_account_id/scc_products/:id/subscribe", + "http_method": "PUT", + "short_description": "Subscribe product", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "scc_account_id", + "full_name": "scc_account_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "discovered_hosts": { + "doc_url": "../apidoc/v2/discovered_hosts", + "api_url": "/api", + "name": "Discovered hosts", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/discovered_hosts/index", + "name": "index", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts", + "http_method": "GET", + "short_description": "List all discovered hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

sort results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

paginate results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

number of entries per request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/show", + "name": "show", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/:id", + "http_method": "GET", + "short_description": "Show a discovered host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/create", + "name": "create", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts", + "http_method": "POST", + "short_description": "Create a discovered host for testing (use /facts to create new hosts)", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "discovered_host", + "full_name": "discovered_host", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "discovered_host[name]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "discovered_host[ip]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mac", + "full_name": "discovered_host[mac]", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pxe_loader", + "full_name": "discovered_host[pxe_loader]", + "description": "\n

DHCP filename option (Grub2 or PXELinux by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/update", + "name": "update", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/:id", + "http_method": "PUT", + "short_description": "Provision a discovered host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "discovered_host", + "full_name": "discovered_host", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "discovered_host[name]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "environment_id", + "full_name": "discovered_host[environment_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ip", + "full_name": "discovered_host[ip]", + "description": "\n

not required if using a subnet with DHCP proxy

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "mac", + "full_name": "discovered_host[mac]", + "description": "\n

not required if it's a virtual machine

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "architecture_id", + "full_name": "discovered_host[architecture_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "domain_id", + "full_name": "discovered_host[domain_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_proxy_id", + "full_name": "discovered_host[puppet_proxy_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_class_ids", + "full_name": "discovered_host[puppet_class_ids]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "operatingsystem_id", + "full_name": "discovered_host[operatingsystem_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "medium_id", + "full_name": "discovered_host[medium_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ptable_id", + "full_name": "discovered_host[ptable_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "discovered_host[subnet_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "sp_subnet_id", + "full_name": "discovered_host[sp_subnet_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "model_id", + "full_name": "discovered_host[model_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "discovered_host[hostgroup_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "owner_id", + "full_name": "discovered_host[owner_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "puppet_ca_proxy_id", + "full_name": "discovered_host[puppet_ca_proxy_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "image_id", + "full_name": "discovered_host[image_id]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_parameters_attributes", + "full_name": "discovered_host[host_parameters_attributes]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "build", + "full_name": "discovered_host[build]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "discovered_host[enabled]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "provision_method", + "full_name": "discovered_host[provision_method]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "managed", + "full_name": "discovered_host[managed]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "progress_report_id", + "full_name": "discovered_host[progress_report_id]", + "description": "\n

UUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "capabilities", + "full_name": "discovered_host[capabilities]", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "root_pass", + "full_name": "discovered_host[root_pass]", + "description": "\n

required if value is not inherited from host group or default password in\nsettings

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "pxe_loader", + "full_name": "discovered_host[pxe_loader]", + "description": "\n

DHCP filename option (Grub2 or PXELinux by default)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/:id", + "http_method": "DELETE", + "short_description": "Delete a discovered host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/facts", + "name": "facts", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/facts", + "http_method": "POST", + "short_description": "Upload facts for a host, creating the host if required", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "facts", + "full_name": "facts", + "description": "\n

hash containing facts for the host with minimum set of facts:\ndiscovery_bootif, macaddress_eth0, ipaddress, ipaddress_eth0, interfaces:\neth0 (example in case primary interface is named eth0)

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/auto_provision", + "name": "auto_provision", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/:id/auto_provision", + "http_method": "POST", + "short_description": "Execute rules against a discovered host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/auto_provision_all", + "name": "auto_provision_all", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/auto_provision_all", + "http_method": "POST", + "short_description": "Execute rules against all currently discovered hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/refresh_facts", + "name": "refresh_facts", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/:id/refresh_facts", + "http_method": "PUT", + "short_description": "Refreshing the facts of a discovered host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/reboot", + "name": "reboot", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/:id/reboot", + "http_method": "PUT", + "short_description": "Rebooting a discovered host", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovered_hosts/reboot_all", + "name": "reboot_all", + "apis": [ + { + "api_url": "/api/v2/discovered_hosts/reboot_all", + "http_method": "PUT", + "short_description": "Rebooting all discovered hosts", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "discovery_rules": { + "doc_url": "../apidoc/v2/discovery_rules", + "api_url": "/api", + "name": "Discovery rules", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/discovery_rules/index", + "name": "index", + "apis": [ + { + "api_url": "/api/v2/discovery_rules", + "http_method": "GET", + "short_description": "List all discovery rules", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

sort results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

paginate results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

number of entries per request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovery_rules/show", + "name": "show", + "apis": [ + { + "api_url": "/api/v2/discovery_rules/:id", + "http_method": "GET", + "short_description": "Show a discovery rule", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovery_rules/create", + "name": "create", + "apis": [ + { + "api_url": "/api/v2/discovery_rules", + "http_method": "POST", + "short_description": "Create a discovery rule", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "discovery_rule", + "full_name": "discovery_rule", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "discovery_rule[name]", + "description": "\n

represents rule name shown to the users

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "discovery_rule[search]", + "description": "\n

query to match discovered hosts for the particular rule

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "discovery_rule[hostgroup_id]", + "description": "\n

the hostgroup that is used to auto provision a host

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostname", + "full_name": "discovery_rule[hostname]", + "description": "\n

defines a pattern to assign human-readable hostnames to the matching hosts

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_count", + "full_name": "discovery_rule[max_count]", + "description": "\n

enables to limit maximum amount of provisioned hosts per rule

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "priority", + "full_name": "discovery_rule[priority]", + "description": "\n

puts the rules in order, low numbers go first. Must be greater then zero

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "discovery_rule[enabled]", + "description": "\n

flag is used for temporary shutdown of rules

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "discovery_rule[location_ids]", + "description": "\n

location ID for provisioned hosts

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "discovery_rule[organization_ids]", + "description": "\n

organization ID for provisioned hosts

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovery_rules/update", + "name": "update", + "apis": [ + { + "api_url": "/api/v2/discovery_rules/:id", + "http_method": "PUT", + "short_description": "Update a rule", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "discovery_rule", + "full_name": "discovery_rule", + "description": "", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "discovery_rule[name]", + "description": "\n

represents rule name shown to the users

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "discovery_rule[search]", + "description": "\n

query to match discovered hosts for the particular rule

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_id", + "full_name": "discovery_rule[hostgroup_id]", + "description": "\n

the hostgroup that is used to auto provision a host

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostname", + "full_name": "discovery_rule[hostname]", + "description": "\n

defines a pattern to assign human-readable hostnames to the matching hosts

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "max_count", + "full_name": "discovery_rule[max_count]", + "description": "\n

enables to limit maximum amount of provisioned hosts per rule

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "priority", + "full_name": "discovery_rule[priority]", + "description": "\n

puts the rules in order, low numbers go first. Must be greater then zero

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "enabled", + "full_name": "discovery_rule[enabled]", + "description": "\n

flag is used for temporary shutdown of rules

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "discovery_rule[location_ids]", + "description": "\n

location ID for provisioned hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "discovery_rule[organization_ids]", + "description": "\n

organization ID for provisioned hosts

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/discovery_rules/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/v2/discovery_rules/:id", + "http_method": "DELETE", + "short_description": "Delete a rule", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "disks": { + "doc_url": "../apidoc/v2/disks", + "api_url": "/api", + "name": "Disks", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/disks/index", + "name": "index", + "apis": [ + { + "api_url": "/bootdisk/api", + "http_method": "GET", + "short_description": "Boot disks", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/disks/generic", + "name": "generic", + "apis": [ + { + "api_url": "/bootdisk/api/generic", + "http_method": "GET", + "short_description": "Download generic image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/disks/host", + "name": "host", + "apis": [ + { + "api_url": "/bootdisk/api/hosts/:host_id", + "http_method": "GET", + "short_description": "Download host image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "full", + "full_name": "full", + "description": "\n

True for full, false for basic reusable image

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "subnet_disks": { + "doc_url": "../apidoc/v2/subnet_disks", + "api_url": "/api", + "name": "Subnet disks", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/subnet_disks/index", + "name": "index", + "apis": [ + { + "api_url": "/bootdisk/api", + "http_method": "GET", + "short_description": "Subnet boot disks", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/subnet_disks/subnet", + "name": "subnet", + "apis": [ + { + "api_url": "/bootdisk/api/subnets/:subnet_id", + "http_method": "GET", + "short_description": "Download subnet generic image", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "subnet_id", + "full_name": "subnet_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "template": { + "doc_url": "../apidoc/v2/template", + "api_url": "/api", + "name": "Template", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/template/import", + "name": "import", + "apis": [ + { + "api_url": "/api/templates/import", + "http_method": "POST", + "short_description": "Initiate Import", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "prefix", + "full_name": "prefix", + "description": "\n

The string all imported templates should begin with.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "associate", + "full_name": "associate", + "description": "\n

Associate to OS's, Locations & Organizations. Options are: always,\nnew or never.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: always, new, never.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "force", + "full_name": "force", + "description": "\n

Update templates that are locked

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "lock", + "full_name": "lock", + "description": "\n

Lock imported templates

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "verbose", + "full_name": "verbose", + "description": "\n

Show template diff in response

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "branch", + "full_name": "branch", + "description": "\n

Branch in Git repo.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repo", + "full_name": "repo", + "description": "\n

Override the default repo from settings.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filter", + "full_name": "filter", + "description": "\n

Export templates with names matching this regex (case-insensitive; snippets\nare not filtered).

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "negate", + "full_name": "negate", + "description": "\n

Negate the prefix (for purging).

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dirname", + "full_name": "dirname", + "description": "\n

The directory within Git repo containing the templates

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "location_ids", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "organization_ids", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/template/export", + "name": "export", + "apis": [ + { + "api_url": "/api/templates/export", + "http_method": "POST", + "short_description": "Initiate Export", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "metadata_export_mode", + "full_name": "metadata_export_mode", + "description": "\n

Specify how to handle metadata

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: refresh, keep, remove.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "branch", + "full_name": "branch", + "description": "\n

Branch in Git repo.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "repo", + "full_name": "repo", + "description": "\n

Override the default repo from settings.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filter", + "full_name": "filter", + "description": "\n

Export templates with names matching this regex (case-insensitive; snippets\nare not filtered).

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "negate", + "full_name": "negate", + "description": "\n

Negate the prefix (for purging).

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "dirname", + "full_name": "dirname", + "description": "\n

The directory within Git repo containing the templates

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "location_ids", + "full_name": "location_ids", + "description": "\n

REPLACE locations with given ids

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_ids", + "full_name": "organization_ids", + "description": "\n

REPLACE organizations with given ids.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "ansible_inventories": { + "doc_url": "../apidoc/v2/ansible_inventories", + "api_url": "/api", + "name": "Ansible inventories", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ansible_inventories/hosts", + "name": "hosts", + "apis": [ + { + "api_url": "/api/ansible_inventories/hosts", + "http_method": "POST", + "short_description": "Show Ansible inventory for hosts", + "deprecated": null + }, + { + "api_url": "/api/ansible_inventories/hosts", + "http_method": "GET", + "short_description": "Show Ansible inventory for hosts", + "deprecated": null + }, + { + "api_url": "/api/ansible_inventories/hostgroups", + "http_method": "POST", + "short_description": "Show Ansible inventory for hostgroups", + "deprecated": null + }, + { + "api_url": "/api/ansible_inventories/hostgroups", + "http_method": "GET", + "short_description": "Show Ansible inventory for hostgroups", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_ids", + "full_name": "host_ids", + "description": "\n

IDs of hosts included in inventory

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hostgroup_ids", + "full_name": "hostgroup_ids", + "description": "\n

IDs of hostgroups included in inventory

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_inventories/schedule", + "name": "schedule", + "apis": [ + { + "api_url": "/api/ansible_inventories/schedule", + "http_method": "POST", + "short_description": "Schedule generating of Ansible Inventory report", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "input_values", + "full_name": "input_values", + "description": "\n

Hash of input values of type input=>value

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "report_format", + "full_name": "report_format", + "description": "\n

Report format, defaults to 'json'

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: csv, json, yaml, html.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [ + "POST /ansible/api/ansible_inventories/schedule\n{\n \"input_values\": {\n \"Organization\": \"yes\",\n \"Location\": \"yes\",\n \"IPv4\": \"yes\",\n \"Facts\": \"no\"\n }\n}\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n" + ], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "ansible_override_values": { + "doc_url": "../apidoc/v2/ansible_override_values", + "api_url": "/api", + "name": "Ansible override values", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ansible_override_values/create", + "name": "create", + "apis": [ + { + "api_url": "/ansible/api/ansible_override_values", + "http_method": "POST", + "short_description": "Create an override value for a specific ansible variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_variable_id", + "full_name": "ansible_variable_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value", + "full_name": "override_value", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "match", + "full_name": "override_value[match]", + "description": "\n

Override match

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "value", + "full_name": "override_value[value]", + "description": "\n

Override value, required if omit is false

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_override_values/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/ansible/api/ansible_override_values/:id", + "http_method": "DELETE", + "short_description": "Destroy an override value", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "ansible_roles": { + "doc_url": "../apidoc/v2/ansible_roles", + "api_url": "/api", + "name": "Ansible roles", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ansible_roles/show", + "name": "show", + "apis": [ + { + "api_url": "/ansible/api/ansible_roles/:id", + "http_method": "GET", + "short_description": "Show role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_roles/index", + "name": "index", + "apis": [ + { + "api_url": "/ansible/api/ansible_roles", + "http_method": "GET", + "short_description": "List Ansible roles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "host", + "type": "string" + }, + { + "name": "host_id", + "type": "integer" + }, + { + "name": "hostgroup", + "type": "string" + }, + { + "name": "hostgroup_id", + "type": "integer" + }, + { + "name": "id", + "type": "integer" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "updated_at", + "type": "datetime" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_roles/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/ansible/api/ansible_roles/:id", + "http_method": "DELETE", + "short_description": "Deletes Ansible role", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_roles/import", + "name": "import", + "apis": [ + { + "api_url": "/ansible/api/ansible_roles/import", + "http_method": "PUT", + "short_description": "Import Ansible roles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy_id", + "full_name": "proxy_id", + "description": "\n

Smart Proxy to import from

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "role_names", + "full_name": "role_names", + "description": "\n

Ansible role names to import

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an array of any type", + "expected_type": "array", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_roles/obsolete", + "name": "obsolete", + "apis": [ + { + "api_url": "/ansible/api/ansible_roles/obsolete", + "http_method": "PUT", + "short_description": "Obsolete Ansible roles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy_id", + "full_name": "proxy_id", + "description": "\n

Smart Proxy to import from

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_roles/fetch", + "name": "fetch", + "apis": [ + { + "api_url": "/ansible/api/ansible_roles/fetch", + "http_method": "GET", + "short_description": "Fetch Ansible roles available to be imported", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy_id", + "full_name": "proxy_id", + "description": "\n

Smart Proxy to fetch from

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "ansible_variables": { + "doc_url": "../apidoc/v2/ansible_variables", + "api_url": "/api", + "name": "Ansible variables", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/ansible_variables/show", + "name": "show", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables/:id", + "http_method": "GET", + "short_description": "Show variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_variables/index", + "name": "index", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables", + "http_method": "GET", + "short_description": "List Ansible variables", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "ansible_role", + "type": "string" + }, + { + "name": "avoid_duplicates", + "values": [ + "true", + "false" + ] + }, + { + "name": "imported", + "values": [ + "true", + "false" + ] + }, + { + "name": "key", + "type": "string" + }, + { + "name": "merge_default", + "values": [ + "true", + "false" + ] + }, + { + "name": "merge_overrides", + "values": [ + "true", + "false" + ] + }, + { + "name": "name", + "type": "string" + }, + { + "name": "override", + "values": [ + "true", + "false" + ] + }, + { + "name": "parameter", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_variables/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables/:id", + "http_method": "DELETE", + "short_description": "Deletes Ansible variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_variables/create", + "name": "create", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables", + "http_method": "POST", + "short_description": "Create Ansible variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_variable", + "full_name": "ansible_variable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "variable", + "full_name": "ansible_variable[variable]", + "description": "\n

Name of variable

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_role_id", + "full_name": "ansible_variable[ansible_role_id]", + "description": "\n

Role ID

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_value", + "full_name": "ansible_variable[default_value]", + "description": "\n

Default value of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "ansible_variable[hidden_value]", + "description": "\n

When enabled the parameter is hidden in the UI

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value_order", + "full_name": "ansible_variable[override_value_order]", + "description": "\n

The order in which values are resolved

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "ansible_variable[description]", + "description": "\n

Description of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_type", + "full_name": "ansible_variable[validator_type]", + "description": "\n

Types of validation values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: regexp, list.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_rule", + "full_name": "ansible_variable[validator_rule]", + "description": "\n

Used to enforce certain values for the parameter values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "variable_type", + "full_name": "ansible_variable[variable_type]", + "description": "\n

Types of variable values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_overrides", + "full_name": "ansible_variable[merge_overrides]", + "description": "\n

Merge all matching values (only array/hash type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_default", + "full_name": "ansible_variable[merge_default]", + "description": "\n

Include default value when merging all matching values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "avoid_duplicates", + "full_name": "ansible_variable[avoid_duplicates]", + "description": "\n

Remove duplicate values (only array type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override", + "full_name": "ansible_variable[override]", + "description": "\n

Whether to override variable or not

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_variables/update", + "name": "update", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables/:id", + "http_method": "PUT", + "short_description": "Updates Ansible variable", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_variable", + "full_name": "ansible_variable", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "variable", + "full_name": "ansible_variable[variable]", + "description": "\n

Name of variable

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "ansible_role_id", + "full_name": "ansible_variable[ansible_role_id]", + "description": "\n

Role ID

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "default_value", + "full_name": "ansible_variable[default_value]", + "description": "\n

Default value of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of types: string, boolean, integer, real, array, hash, yaml, json", + "expected_type": "any_type", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hidden_value", + "full_name": "ansible_variable[hidden_value]", + "description": "\n

When enabled the parameter is hidden in the UI

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override_value_order", + "full_name": "ansible_variable[override_value_order]", + "description": "\n

The order in which values are resolved

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "ansible_variable[description]", + "description": "\n

Description of variable

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_type", + "full_name": "ansible_variable[validator_type]", + "description": "\n

Types of validation values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: regexp, list.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "validator_rule", + "full_name": "ansible_variable[validator_rule]", + "description": "\n

Used to enforce certain values for the parameter values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "variable_type", + "full_name": "ansible_variable[variable_type]", + "description": "\n

Types of variable values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_overrides", + "full_name": "ansible_variable[merge_overrides]", + "description": "\n

Merge all matching values (only array/hash type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "merge_default", + "full_name": "ansible_variable[merge_default]", + "description": "\n

Include default value when merging all matching values

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "avoid_duplicates", + "full_name": "ansible_variable[avoid_duplicates]", + "description": "\n

Remove duplicate values (only array type)

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "override", + "full_name": "ansible_variable[override]", + "description": "\n

Whether to override variable or not

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_variables/import", + "name": "import", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables/import", + "http_method": "PUT", + "short_description": "Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy_id", + "full_name": "proxy_id", + "description": "\n

Smart Proxy to import from

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/ansible_variables/obsolete", + "name": "obsolete", + "apis": [ + { + "api_url": "/ansible/api/ansible_variables/obsolete", + "http_method": "PUT", + "short_description": "Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy_id", + "full_name": "proxy_id", + "description": "\n

Smart Proxy to import from

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + }, + "snapshots": { + "doc_url": "../apidoc/v2/snapshots", + "api_url": "/api", + "name": "Snapshots", + "short_description": null, + "full_description": null, + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/snapshots/index", + "name": "index", + "apis": [ + { + "api_url": "/api/hosts/:host_id/snapshots", + "http_method": "GET", + "short_description": "List all snapshots", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": { + "search": [ + { + "name": "name", + "type": "string" + } + ] + }, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/snapshots/show", + "name": "show", + "apis": [ + { + "api_url": "/api/hosts/:host_id/snapshots/:id", + "http_method": "GET", + "short_description": "Show a snapshot", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/snapshots/create", + "name": "create", + "apis": [ + { + "api_url": "/api/hosts/:host_id/snapshots", + "http_method": "POST", + "short_description": "Create a snapshot", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "include_ram", + "full_name": "include_ram", + "description": "\n

Whether to include the RAM state in the snapshot

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snapshot", + "full_name": "snapshot", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "snapshot[name]", + "description": "\n

Name of this snapshot

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "snapshot[description]", + "description": "\n

Description of this snapshot

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/snapshots/update", + "name": "update", + "apis": [ + { + "api_url": "/api/hosts/:host_id/snapshots/:id", + "http_method": "PUT", + "short_description": "Update a snapshot", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "snapshot", + "full_name": "snapshot", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "snapshot[name]", + "description": "\n

Name of this snapshot

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "description", + "full_name": "snapshot[description]", + "description": "\n

Description of this snapshot

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/snapshots/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/api/hosts/:host_id/snapshots/:id", + "http_method": "DELETE", + "short_description": "Delete a snapshot", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/snapshots/revert", + "name": "revert", + "apis": [ + { + "api_url": "/api/hosts/:host_id/snapshots/:id/revert", + "http_method": "PUT", + "short_description": "Revert Host to a snapshot", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "host_id", + "full_name": "host_id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": null, + "deprecated": null + }, + "configs": { + "doc_url": "../apidoc/v2/configs", + "api_url": "/api", + "name": "Configs", + "short_description": null, + "full_description": "", + "version": "v2", + "formats": null, + "metadata": null, + "methods": [ + { + "doc_url": "../apidoc/v2/configs/index", + "name": "index", + "apis": [ + { + "api_url": "/foreman_virt_who_configure/api/v2/configs", + "http_method": "GET", + "short_description": "List of virt-who configurations", + "deprecated": null + }, + { + "api_url": "/foreman_virt_who_configure/api/v2/organizations/:organization_id/configs", + "http_method": "GET", + "short_description": "List of virt-who configurations per organization", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "search", + "full_name": "search", + "description": "\n

filter results

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "order", + "full_name": "order", + "description": "\n

Sort field and order, eg. \u2018id DESC\u2019

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "page", + "full_name": "page", + "description": "\n

Page number, starting at 1

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "per_page", + "full_name": "per_page", + "description": "\n

Number of results per page to return

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/configs/show", + "name": "show", + "apis": [ + { + "api_url": "/foreman_virt_who_configure/api/v2/configs/:id", + "http_method": "GET", + "short_description": "Show a virt-who configuration", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/configs/deploy_script", + "name": "deploy_script", + "apis": [ + { + "api_url": "/foreman_virt_who_configure/api/v2/configs/:id/deploy_script", + "http_method": "GET", + "short_description": "Renders a deploy script for the specified virt-who configuration", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/configs/create", + "name": "create", + "apis": [ + { + "api_url": "/foreman_virt_who_configure/api/v2/configs", + "http_method": "POST", + "short_description": "Create a virt-who configuration", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "foreman_virt_who_configure_config", + "full_name": "foreman_virt_who_configure_config", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "foreman_virt_who_configure_config[name]", + "description": "\n

Configuration name

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "foreman_virt_who_configure_config[interval]", + "description": "\n

Configuration interval in minutes

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: 60, 120, 240, 480, 720, 1440, 2880, 4320.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filtering_mode", + "full_name": "foreman_virt_who_configure_config[filtering_mode]", + "description": "\n

Hypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means\nblacklist

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: 0, 1, 2.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "whitelist", + "full_name": "foreman_virt_who_configure_config[whitelist]", + "description": "\n

Hypervisor whitelist, applicable only when filtering mode is set to 1.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "blacklist", + "full_name": "foreman_virt_who_configure_config[blacklist]", + "description": "\n

Hypervisor blacklist, applicable only when filtering mode is set to 2.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filter_host_parents", + "full_name": "foreman_virt_who_configure_config[filter_host_parents]", + "description": "\n

Applicable only for esx provider type. Only hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill be reported. Wildcards and regular expressions are supported, multiple\nrecords must be separated by comma. Put the value into the double-quotes if\nit contains special characters like comma. All new line characters will be\nremoved in resulting configuration file, white spaces are removed from\nbeginning and end.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "exclude_host_parents", + "full_name": "foreman_virt_who_configure_config[exclude_host_parents]", + "description": "\n

Applicable only for esx provider type. Hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill NOT be reported. Wildcards and regular expressions\nare supported, multiple records must be separated by comma. Put the value\ninto the double-quotes if it contains special characters like comma. All\nnew line characters will be removed in resulting configuration file, white\nspaces are removed from beginning and end.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_id", + "full_name": "foreman_virt_who_configure_config[hypervisor_id]", + "description": "\n

Specifies how the hypervisor will be identified.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: hostname, uuid, hwuuid.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_type", + "full_name": "foreman_virt_who_configure_config[hypervisor_type]", + "description": "\n

Hypervisor type

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: esx, rhevm, hyperv, xen, libvirt, kubevirt.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_server", + "full_name": "foreman_virt_who_configure_config[hypervisor_server]", + "description": "\n

Fully qualified host name or IP address of the hypervisor

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_username", + "full_name": "foreman_virt_who_configure_config[hypervisor_username]", + "description": "\n

Account name by which virt-who is to connect to the hypervisor.

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_password", + "full_name": "foreman_virt_who_configure_config[hypervisor_password]", + "description": "\n

Hypervisor password, required for all hypervisor types except for libvirt

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "satellite_url", + "full_name": "foreman_virt_who_configure_config[satellite_url]", + "description": "\n

Satellite server FQDN

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "debug", + "full_name": "foreman_virt_who_configure_config[debug]", + "description": "\n

Enable debugging output

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy", + "full_name": "foreman_virt_who_configure_config[proxy]", + "description": "\n

HTTP proxy that should be used for communication between the server on\nwhich virt-who is running and the hypervisors and virtualization managers.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "no_proxy", + "full_name": "foreman_virt_who_configure_config[no_proxy]", + "description": "\n

Ignore proxy. A comma-separated list of hostnames or domains or ip\naddresses to ignore proxy settings for. Optionally this may be set to * to\nbypass proxy settings for all hostnames domains or ip addresses.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "foreman_virt_who_configure_config[organization_id]", + "description": "\n

Organization of the virt-who configuration

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/configs/update", + "name": "update", + "apis": [ + { + "api_url": "/foreman_virt_who_configure/api/v2/configs/:id", + "http_method": "PUT", + "short_description": "Update a virt-who configuration", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Configuration numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "foreman_virt_who_configure_config", + "full_name": "foreman_virt_who_configure_config", + "description": "", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Hash", + "expected_type": "hash", + "metadata": null, + "show": true, + "validations": [], + "params": [ + { + "name": "name", + "full_name": "foreman_virt_who_configure_config[name]", + "description": "\n

Configuration name

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "interval", + "full_name": "foreman_virt_who_configure_config[interval]", + "description": "\n

Configuration interval in minutes

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: 60, 120, 240, 480, 720, 1440, 2880, 4320.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filtering_mode", + "full_name": "foreman_virt_who_configure_config[filtering_mode]", + "description": "\n

Hypervisor filtering mode, 0 means no filtering, 1 means whitelist, 2 means\nblacklist

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: 0, 1, 2.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "whitelist", + "full_name": "foreman_virt_who_configure_config[whitelist]", + "description": "\n

Hypervisor whitelist, applicable only when filtering mode is set to 1.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "blacklist", + "full_name": "foreman_virt_who_configure_config[blacklist]", + "description": "\n

Hypervisor blacklist, applicable only when filtering mode is set to 2.\nWildcards and regular expressions are supported, multiple records must be\nseparated by comma.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "filter_host_parents", + "full_name": "foreman_virt_who_configure_config[filter_host_parents]", + "description": "\n

Applicable only for esx provider type. Only hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill be reported. Wildcards and regular expressions are supported, multiple\nrecords must be separated by comma. Put the value into the double-quotes if\nit contains special characters like comma. All new line characters will be\nremoved in resulting configuration file, white spaces are removed from\nbeginning and end.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "exclude_host_parents", + "full_name": "foreman_virt_who_configure_config[exclude_host_parents]", + "description": "\n

Applicable only for esx provider type. Hosts which parent (usually\nComputeResource) name is specified in comma-separated list in this option\nwill NOT be reported. Wildcards and regular expressions\nare supported, multiple records must be separated by comma. Put the value\ninto the double-quotes if it contains special characters like comma. All\nnew line characters will be removed in resulting configuration file, white\nspaces are removed from beginning and end.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_id", + "full_name": "foreman_virt_who_configure_config[hypervisor_id]", + "description": "\n

Specifies how the hypervisor will be identified.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: hostname, uuid, hwuuid.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_type", + "full_name": "foreman_virt_who_configure_config[hypervisor_type]", + "description": "\n

Hypervisor type

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be one of: esx, rhevm, hyperv, xen, libvirt, kubevirt.", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_server", + "full_name": "foreman_virt_who_configure_config[hypervisor_server]", + "description": "\n

Fully qualified host name or IP address of the hypervisor

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_username", + "full_name": "foreman_virt_who_configure_config[hypervisor_username]", + "description": "\n

Account name by which virt-who is to connect to the hypervisor.

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "hypervisor_password", + "full_name": "foreman_virt_who_configure_config[hypervisor_password]", + "description": "\n

Hypervisor password, required for all hypervisor types except for libvirt

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "satellite_url", + "full_name": "foreman_virt_who_configure_config[satellite_url]", + "description": "\n

Satellite server FQDN

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "debug", + "full_name": "foreman_virt_who_configure_config[debug]", + "description": "\n

Enable debugging output

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "Must be one of: true, false, 1, 0.", + "expected_type": "boolean", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "proxy", + "full_name": "foreman_virt_who_configure_config[proxy]", + "description": "\n

HTTP proxy that should be used for communication between the server on\nwhich virt-who is running and the hypervisors and virtualization managers.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "no_proxy", + "full_name": "foreman_virt_who_configure_config[no_proxy]", + "description": "\n

Ignore proxy. A comma-separated list of hostnames or domains or ip\naddresses to ignore proxy settings for. Optionally this may be set to * to\nbypass proxy settings for all hostnames domains or ip addresses.

\n", + "required": false, + "allow_nil": true, + "allow_blank": false, + "validator": "String", + "expected_type": "string", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "foreman_virt_who_configure_config[organization_id]", + "description": "\n

Organization of the virt-who configuration

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + }, + { + "doc_url": "../apidoc/v2/configs/destroy", + "name": "destroy", + "apis": [ + { + "api_url": "/foreman_virt_who_configure/api/v2/configs/:id", + "http_method": "DELETE", + "short_description": "Delete a virt-who configuration", + "deprecated": null + } + ], + "formats": null, + "full_description": "", + "errors": [], + "params": [ + { + "name": "location_id", + "full_name": "location_id", + "description": "\n

Set the current location context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "organization_id", + "full_name": "organization_id", + "description": "\n

Set the current organization context for the request

\n", + "required": false, + "allow_nil": false, + "allow_blank": false, + "validator": "Integer", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + }, + { + "name": "id", + "full_name": "id", + "description": "\n

Configuration numeric identifier

\n", + "required": true, + "allow_nil": false, + "allow_blank": false, + "validator": "Must be a number.", + "expected_type": "numeric", + "metadata": null, + "show": true, + "validations": [] + } + ], + "returns": [], + "examples": [], + "metadata": null, + "see": [], + "headers": [], + "show": true + } + ], + "headers": [], + "deprecated": false + } + }, + "link_extension": ".html" + } +}