• Foreman v2

Resources

Architectures

Resource	Description
GET /api/architectures	List all architectures.
GET /api/architectures/:id	Show an architecture.
POST /api/architectures	Create an architecture.
PUT /api/architectures/:id	Update an architecture.
DELETE /api/architectures/:id	Delete an architecture.

Audits

Resource	Description
GET /api/audits	List all audits.
GET /api/hosts/:host_id/audits	List all audits for a given host.
GET /api/audits/:id	Show an audit

Auth source ldaps

Resource	Description
GET /api/auth_source_ldaps	List all authsource ldaps
GET /api/auth_source_ldaps/:id	Show an authsource ldap.
POST /api/auth_source_ldaps	Create an auth_source_ldap.
PUT /api/auth_source_ldaps/:id	Update an auth_source_ldap.
DELETE /api/auth_source_ldaps/:id	Delete an auth_source_ldap.

Bookmarks

Resource	Description
GET /api/bookmarks	List all bookmarks.
GET /api/bookmarks/:id	Show a bookmark.
POST /api/bookmarks	Create a bookmark.
PUT /api/bookmarks/:id	Update a bookmark.
DELETE /api/bookmarks/:id	Delete a bookmark.

Common parameters

Resource	Description
GET /api/common_parameters	List all common parameters.
GET /api/common_parameters/:id	Show a common parameter.
POST /api/common_parameters	Create a common_parameter
PUT /api/common_parameters/:id	Update a common_parameter
DELETE /api/common_parameters/:id	Delete a common_parameter

Compute resources

Resource	Description
GET /api/compute_resources	List all compute resources.
GET /api/compute_resources/:id	Show an compute resource.
POST /api/compute_resources	Create a compute resource.
PUT /api/compute_resources/:id	Update a compute resource.
DELETE /api/compute_resources/:id	Delete a compute resource.

Config templates

Resource	Description
GET /api/config_templates	List templates
GET /api/config_templates/:id	Show template details
POST /api/config_templates	Create a template
PUT /api/config_templates/:id	Update a template
GET /api/config_templates/revision
DELETE /api/config_templates/:id	Delete a template
GET /api/config_templates/build_pxe_default	Change the default PXE menu on all configured TFTP servers

Dashboard

Resource	Description
GET /api/dashboard	Get Dashboard results

Domains

Resource	Description
GET /api/domains	List of domains
GET /api/domains/:id	Show a domain.
POST /api/domains	Create a domain.
PUT /api/domains/:id	Update a domain.
DELETE /api/domains/:id	Delete a domain.

Environments

Resource	Description
GET /api/environments	List all environments.
GET /api/environments/:id	Show an environment.
POST /api/environments	Create an environment.
PUT /api/environments/:id	Update an environment.
DELETE /api/environments/:id	Delete an environment.

Fact values

Resource	Description
GET /api/fact_values	List all fact values.
GET /api/hosts/:host_id/facts	List all fact values of a given host.

Home

Resource	Description
GET /api	Show available links.
GET /api/status	Show status.

Host classes

Resource	Description
GET /api/hosts/:host_id/puppetclass_ids	List all puppetclass id's for host
POST /api/hosts/:host_id/puppetclass_ids	Add a puppetclass to host
DELETE /api/hosts/:host_id/puppetclass_ids/:id	Remove a puppetclass from host

Hostgroup classes

Resource	Description
GET /api/hostgroups/:hostgroup_id/puppetclass_ids	List all puppetclass id's for hostgroup
POST /api/hostgroups/:hostgroup_id/puppetclass_ids	Add a puppetclass to hostgroup
DELETE /api/hostgroups/:hostgroup_id/puppetclass_ids/:id	Remove a puppetclass from hostgroup

Hostgroups

Resource	Description
GET /api/hostgroups	List all hostgroups.
GET /api/hostgroups/:id	Show a hostgroup.
POST /api/hostgroups	Create an hostgroup.
PUT /api/hostgroups/:id	Update an hostgroup.
DELETE /api/hostgroups/:id	Delete an hostgroup.

Hosts

Resource	Description
GET /api/hosts	List all hosts.
GET /api/hosts/:id	Show a host.
POST /api/hosts	Create a host.
PUT /api/hosts/:id	Update a host.
DELETE /api/hosts/:id	Delete an host.
GET /api/hosts/:id/status	Get status of host
GET /api/hosts/:id/puppetrun	Force a puppet run on the agent.
PUT /api/hosts/:id/power	Run power operation on host.
PUT /api/hosts/:id/boot	Boot host from specified device.
POST /api/hosts/facts	Upload facts for a host, creating the host if required.

Images

Resource	Description
GET /api/compute_resources/:compute_resource_id/images	List all images for compute resource
GET /api/compute_resources/:compute_resource_id/images/:id	Show an image
POST /api/compute_resources/:compute_resource_id/images	Create a image
PUT /api/compute_resources/:compute_resource_id/images/:id	Update a image.
DELETE /api/compute_resources/:compute_resource_id/images/:id	Delete an image.

Interfaces

Resource	Description
GET /api/hosts/:host_id/interfaces	List all interfaces for host
GET /api/hosts/:host_id/interfaces/:id	Show an interface for host
POST /api/hosts/:host_id/interfaces	Create an interface linked to a host
PUT /api/hosts/:host_id/interfaces/:id	Update host interface
DELETE /api/hosts/:host_id/interfaces/:id	Delete a host interface

Locations

Resource	Description
GET /api/locations	List all locations
GET /api/locations/:id	Show a location
POST /api/locations	Create a location
PUT /api/locations/:id	Update a location
DELETE /api/locations/:id	Delete a location

Lookup keys

Resource	Description
GET /api/lookup_keys	List all lookup_keys.
GET /api/lookup_keys/:id	Show a lookup key.
POST /api/lookup_keys	Create a lookup key.
PUT /api/lookup_keys/:id	Update a lookup key.
DELETE /api/lookup_keys/:id	Delete a lookup key.

Media

Resource	Description
GET /api/media	List all media.
GET /api/media/:id	Show a medium.
POST /api/media	Create a medium.
PUT /api/media/:id	Update a medium.
DELETE /api/media/:id	Delete a medium.

Models

Resource	Description
GET /api/models	List all models.
GET /api/models/:id	Show a model.
POST /api/models	Create a model.
PUT /api/models/:id	Update a model.
DELETE /api/models/:id	Delete a model.

Operating systems

Resource	Description
GET /api/operatingsystems	List all operating systems.
GET /api/operatingsystems/:id	Show an OS.
POST /api/operatingsystems	Create an OS.
PUT /api/operatingsystems/:id	Update an OS.
DELETE /api/operatingsystems/:id	Delete an OS.
GET /api/operatingsystems/:id/bootfiles	List boot files an OS.

Organizations

Resource	Description
GET /api/organizations	List all organizations
GET /api/organizations/:id	Show an organization
POST /api/organizations	Create an organization
PUT /api/organizations/:id	Update an organization
DELETE /api/organizations/:id	Delete an organization

Override values

Resource	Description
GET /api/smart_variables/:smart_variable_id/override_values	List of override values for a specific smart_variable
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values	List of override values for a specific smart class parameter
GET /api/smart_variables/:smart_variable_id/override_values/:id	Show an override value for a specific smart_variable
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id	Show an override value for a specific smart class parameter
POST /api/smart_variables/:smart_variable_id/override_values	Create an override value for a specific smart_variable
POST /api/smart_class_parameters/:smart_class_parameter_id/override_values	Create an override value for a specific smart class parameter
PUT /api/smart_variables/:smart_variable_id/override_values/:id	Update an override value for a specific smart_variable
PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id	Update an override value for a specific smart class parameter
DELETE /api/smart_variables/:smart_variable_id/override_values/:id	Delete an override value for a specific smart_variable
DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id	Delete an override value for a specific smart class parameter

Parameters

Resource	Description
GET /api/hosts/:host_id/parameters	List all parameters for host
GET /api/hostgroups/:hostgroup_id/parameters	List all parameters for hostgroup
GET /api/domains/:domain_id/parameters	List all parameters for domain
GET /api/operatingsystems/:operatingsystem_id/parameters	List all parameters for operating system
GET /api/hosts/:host_id/parameters/:id	Show a nested parameter for host
GET /api/hostgroups/:hostgroup_id/parameters/:id	Show a nested parameter for hostgroup
GET /api/domains/:domain_id/parameters/:id	Show a nested parameter for domain
GET /api/operatingsystems/:operatingsystem_id/parameters/:id	Show a nested parameter for operating system
POST /api/hosts/:host_id/parameters	Create a nested parameter for host
POST /api/hostgroups/:hostgroup_id/parameters	Create a nested parameter for hostgroup
POST /api/domains/:domain_id/parameters	Create a nested parameter for domain
POST /api/operatingsystems/:operatingsystem_id/parameters	Create a nested parameter for operating system
PUT /api/hosts/:host_id/parameters/:id	Update a nested parameter for host
PUT /api/hostgroups/:hostgroup_id/parameters/:id	Update a nested parameter for hostgroup
PUT /api/domains/:domain_id/parameters/:id	Update a nested parameter for domain
PUT /api/operatingsystems/:operatingsystem_id/parameters/:id	Update a nested parameter for operating system
DELETE /api/hosts/:host_id/parameters/:id	Delete a nested parameter for host
DELETE /api/hostgroups/:hostgroup_id/parameters/:id	Delete a nested parameter for hostgroup
DELETE /api/domains/:domain_id/parameters/:id	Delete a nested parameter for domain
DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id	Delete a nested parameter for operating system
DELETE /api/hosts/:host_id/parameters	Delete all nested parameters for host
DELETE /api/hostgroups/:hostgroup_id/parameters	Delete all nested parameters for hostgroup
DELETE /api/domains/:domain_id/parameters	Delete all nested parameters for domain
DELETE /api/operatingsystems/:operatingsystem_id/parameters	Delete all nested parameters for operating system

Ptables

Resource	Description
GET /api/ptables	List all ptables.
GET /api/ptables/:id	Show a ptable.
POST /api/ptables	Create a ptable.
PUT /api/ptables/:id	Update a ptable.
DELETE /api/ptables/:id	Delete a ptable.

Puppetclasses

Resource	Description
GET /api/puppetclasses	List all puppetclasses.
GET /api/hosts/:host_id/puppetclasses	List all puppetclasses for host
GET /api/hostgroups/:hostgroup_id/puppetclasses	List all puppetclasses for hostgroup
GET /api/environments/:environment_id/puppetclasses	List all puppetclasses for environment
GET /api/puppetclasses/:id	Show a puppetclass
GET /api/hosts/:host_id/puppetclasses/:id	Show a puppetclass for host
GET /api/hostgroups/:hostgroup_id/puppetclasses/:id	Show a puppetclass for hostgroup
GET /api/environments/:environment_id/puppetclasses/:id	Show a puppetclass for environment
POST /api/puppetclasses	Create a puppetclass.
PUT /api/puppetclasses/:id	Update a puppetclass.
DELETE /api/puppetclasses/:id	Delete a puppetclass.

Reports

Resource	Description
GET /api/reports	List all reports.
GET /api/reports/:id	Show a report.
DELETE /api/ptables/:id	Delete a report.
GET /api/hosts/:host_id/reports/last	Show the last report for a given host.
POST /api/reports	Create a report.

Roles

Resource	Description
GET /api/roles	List all roles.
GET /api/roles/:id	Show an role.
POST /api/roles	Create an role.
PUT /api/roles/:id	Update an role.
DELETE /api/roles/:id	Delete an role.

Settings

Resource	Description
GET /api/settings	List all settings.
GET /api/settings/:id	Show an setting.
PUT /api/settings/:id	Update a setting.

Smart class parameters

Resource	Description
GET /api/smart_class_parameters	List all smart class parameters
GET /api/hosts/:host_id/smart_class_parameters	List of smart class parameters for a specific host
GET /api/hostgroups/:hostgroup_id/smart_class_parameters	List of smart class parameters for a specific hostgroup
GET /api/puppetclasses/:puppetclass_id/smart_class_parameters	List of smart class parameters for a specific puppetclass
GET /api/environments/:environment_id/smart_class_parameters	List of smart class parameters for a specific environment
GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters	List of smart class parameters for a specific environment/puppetclass combination
GET /api/smart_class_parameters/:id	Show a smart class parameter.
PUT /api/smart_class_parameters/:id	Update a smart class parameter.

Smart proxies

Resource	Description
GET /api/smart_proxies	List all smart_proxies.
GET /api/smart_proxies/:id	Show a smart proxy.
POST /api/smart_proxies	Create a smart proxy.
PUT /api/smart_proxies/:id	Update a smart proxy.
DELETE /api/smart_proxies/:id	Delete a smart_proxy.

Smart variables

Resource	Description
GET /api/smart_variables	List all smart variables
GET /api/hosts/:host_id/smart_variables	List of smart variables for a specific host
GET /api/hostgroups/:hostgroup_id/smart_variables	List of smart variables for a specific hostgroup
GET /api/puppetclasses/:puppetclass_id/smart_variables	List of smart variables for a specific puppetclass
GET /api/smart_variables/:id	Show a smart variable.
POST /api/smart_variables	Create a smart variable.
PUT /api/smart_variables/:id	Update a smart variable.
DELETE /api/smart_variables/:id	Delete a smart variable.

Statistics

Resource	Description
GET /api/statistics	Get statistics

Subnets

Resource	Description
GET /api/subnets	List of subnets
GET /api/subnets/:id	Show a subnet.
POST /api/subnets	Create a subnet
PUT /api/subnets/:id	Update a subnet
DELETE /api/subnets/:id	Delete a subnet

Template combinations

Resource	Description
GET /api/config_templates/:config_template_id/template_combinations	List Template Combination
POST /api/config_templates/:config_template_id/template_combinations	Add a Template Combination
GET /api/template_combinations/:id	Show Template Combination
DELETE /api/template_combinations/:id	Delete a template

Template kinds

Resource	Description
GET /api/template_kinds	List all template kinds.

Usergroups

Resource	Description
GET /api/usergroups	List all usergroups.
GET /api/usergroups/:id	Show a usergroup.
POST /api/usergroups	Create a usergroup.
PUT /api/usergroups/:id	Update a usergroup.
DELETE /api/usergroups/:id	Delete a usergroup.

Users

Resource	Description
GET /api/users	List all users.
GET /api/users/:id	Show an user.
POST /api/users	Create an user.
PUT /api/users/:id	Update an user.
DELETE /api/users/:id	Delete an user.