Examples

GET /api
200
{
  "links": {
    "base": {},
    "config_reports": {
      "List all reports": "/api/config_reports",
      "Show a report": "/api/config_reports/:id",
      "Create a report": "/api/config_reports",
      "Delete a report": "/api/config_reports/:id",
      "Show the last report for a host": "/api/hosts/:host_id/config_reports/last"
    },
    "bookmarks": {
      "List all bookmarks": "/api/bookmarks",
      "Show a bookmark": "/api/bookmarks/:id",
      "Create a bookmark": "/api/bookmarks",
      "Update a bookmark": "/api/bookmarks/:id",
      "Delete a bookmark": "/api/bookmarks/:id"
    },
    "host_classes": {
      "List all Puppet class IDs for host": "/api/hosts/:host_id/puppetclass_ids",
      "Add a Puppet class to host": "/api/hosts/:host_id/puppetclass_ids",
      "Remove a Puppet class from host": "/api/hosts/:host_id/puppetclass_ids/:id"
    },
    "organizations": {
      "List all organizations": "/api/organizations",
      "Show an organization": "/api/organizations/:id",
      "Create an organization": "/api/organizations",
      "Update an organization": "/api/organizations/:id",
      "Delete an organization": "/api/organizations/:id"
    },
    "auth_source_ldaps": {
      "List all LDAP authentication sources": "/api/auth_source_ldaps",
      "Show an LDAP authentication source": "/api/auth_source_ldaps/:id",
      "Create an LDAP authentication source": "/api/auth_source_ldaps",
      "Update an LDAP authentication source": "/api/auth_source_ldaps/:id",
      "Test LDAP connection": "/api/auth_source_ldaps/:id/test",
      "Delete an LDAP authentication source": "/api/auth_source_ldaps/:id"
    },
    "media": {
      "List all installation media": "/api/media",
      "Show a medium": "/api/media/:id",
      "Create a medium": "/api/media",
      "Update a medium": "/api/media/:id",
      "Delete a medium": "/api/media/:id"
    },
    "ptables": {
      "List all partition tables": "/api/ptables",
      "Show a partition table": "/api/ptables/:id",
      "Create a partition table": "/api/ptables",
      "Import a provisioning template": "/api/ptables/import",
      "Update a partition table": "/api/ptables/:id",
      "Delete a partition table": "/api/ptables/:id",
      "Clone a template": "/api/ptables/:id/clone",
      "Export a partition template to ERB": "/api/ptables/:id/export"
    },
    "compute_resources": {
      "List all compute resources": "/api/compute_resources",
      "Show a compute resource": "/api/compute_resources/:id",
      "Create a compute resource": "/api/compute_resources",
      "Update a compute resource": "/api/compute_resources/:id",
      "Delete a compute resource": "/api/compute_resources/:id",
      "List available images for a compute resource": "/api/compute_resources/:id/available_images",
      "List available clusters for a compute resource": "/api/compute_resources/:id/available_clusters",
      "List available flavors for a compute resource": "/api/compute_resources/:id/available_flavors",
      "List available folders for a compute resource": "/api/compute_resources/:id/available_folders",
      "List available zone for a compute resource": "/api/compute_resources/:id/available_zones",
      "List available networks for a compute resource": "/api/compute_resources/:id/available_networks",
      "List resource pools for a compute resource cluster": "/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools",
      "List storage domains for a compute resource": "/api/compute_resources/:id/available_storage_domains",
      "List storage pods for a compute resource": "/api/compute_resources/:id/available_storage_pods",
      "List available security groups for a compute resource": "/api/compute_resources/:id/available_security_groups",
      "Associate VMs to Hosts": "/api/compute_resources/:id/associate",
      "Refresh Compute Resource Cache": "/api/compute_resources/:id/refresh_cache"
    },
    "hostgroup_classes": {
      "List all Puppet class IDs for host group": "/api/hostgroups/:hostgroup_id/puppetclass_ids",
      "Add a Puppet class to host group": "/api/hostgroups/:hostgroup_id/puppetclass_ids",
      "Remove a Puppet class from host group": "/api/hostgroups/:hostgroup_id/puppetclass_ids/:id"
    },
    "roles": {
      "List all roles": "/api/roles",
      "Show a role": "/api/roles/:id",
      "Create a role": "/api/roles",
      "Update a role": "/api/roles/:id",
      "Delete a role": "/api/roles/:id",
      "Clone a role": "/api/roles/:id/clone"
    },
    "trends": {
      "List of trends counters": "/api/trends",
      "Show a trend": "/api/trends/:id",
      "Create a trend counter": "/api/trends",
      "Delete a trend counter": "/api/trends/:id"
    },
    "fact_values": {
      "List all fact values": "/api/fact_values"
    },
    "permissions": {
      "List all permissions": "/api/permissions",
      "Show a permission": "/api/permissions/:id",
      "List available resource types": "/api/permissions/resource_types"
    },
    "filters": {
      "List all filters": "/api/filters",
      "Show a filter": "/api/filters/:id",
      "Create a filter": "/api/filters",
      "Update a filter": "/api/filters/:id",
      "Delete a filter": "/api/filters/:id"
    },
    "smart_variables": {
      "List all smart variables": "/api/smart_variables",
      "Show a smart variable": "/api/smart_variables/:id",
      "Create a smart variable": "/api/smart_variables",
      "Update a smart variable": "/api/smart_variables/:id",
      "Delete a smart variable": "/api/smart_variables/:id"
    },
    "smart_proxies": {
      "Import puppet classes from puppet proxy": "/api/smart_proxies/:id/import_puppetclasses",
      "List all smart proxies": "/api/smart_proxies",
      "Show a smart proxy": "/api/smart_proxies/:id",
      "Create a smart proxy": "/api/smart_proxies",
      "Update a smart proxy": "/api/smart_proxies/:id",
      "Delete a smart proxy": "/api/smart_proxies/:id",
      "Refresh smart proxy features": "/api/smart_proxies/:id/refresh"
    },
    "hostgroups": {
      "List all host groups": "/api/hostgroups",
      "Show a host group": "/api/hostgroups/:id",
      "Create a host group": "/api/hostgroups",
      "Update a host group": "/api/hostgroups/:id",
      "Delete a host group": "/api/hostgroups/:id",
      "Clone a host group": "/api/hostgroups/:id/clone",
      "Rebuild orchestration config": "/api/hostgroups/:id/rebuild_config"
    },
    "images": {
      "List all images for a compute resource": "/api/compute_resources/:compute_resource_id/images",
      "Show an image": "/api/compute_resources/:compute_resource_id/images/:id",
      "Create an image": "/api/compute_resources/:compute_resource_id/images",
      "Update an image": "/api/compute_resources/:compute_resource_id/images/:id",
      "Delete an image": "/api/compute_resources/:compute_resource_id/images/:id"
    },
    "models": {
      "List all hardware models": "/api/models",
      "Show a hardware model": "/api/models/:id",
      "Create a hardware model": "/api/models",
      "Update a hardware model": "/api/models/:id",
      "Delete a hardware model": "/api/models/:id"
    },
    "template_combinations": {
      "List template combination": "/api/config_templates/:config_template_id/template_combinations",
      "Add a template combination": "/api/config_templates/:config_template_id/template_combinations",
      "Show template combination": "/api/template_combinations/:id",
      "Update template combination": "/api/provisioning_templates/:provisioning_template_id/template_combinations/:id",
      "Delete a template combination": "/api/template_combinations/:id"
    },
    "puppetclasses": {
      "List all Puppet classes": "/api/puppetclasses",
      "Show a Puppet class": "/api/puppetclasses/:id",
      "Create a Puppet class": "/api/puppetclasses",
      "Update a Puppet class": "/api/puppetclasses/:id",
      "Delete a Puppet class": "/api/puppetclasses/:id"
    },
    "smart_class_parameters": {
      "List all smart class parameters": "/api/smart_class_parameters",
      "Show a smart class parameter": "/api/smart_class_parameters/:id",
      "Update a smart class parameter": "/api/smart_class_parameters/:id"
    },
    "external_usergroups": {
      "List all external user groups for user group": "/api/usergroups/:usergroup_id/external_usergroups",
      "Show an external user group for user group": "/api/usergroups/:usergroup_id/external_usergroups/:id",
      "Create an external user group linked to a user group": "/api/usergroups/:usergroup_id/external_usergroups",
      "Update external user group": "/api/usergroups/:usergroup_id/external_usergroups/:id",
      "Refresh external user group": "/api/usergroups/:usergroup_id/external_usergroups/:id/refresh",
      "Delete an external user group": "/api/usergroups/:usergroup_id/external_usergroups/:id"
    },
    "config_templates": {
      "List provisioning templates": "/api/config_templates",
      "Show provisioning template details": "/api/config_templates/:id",
      "Create a provisioning template": "/api/config_templates",
      "Update a provisioning template": "/api/config_templates/:id",
      "Delete a provisioning template": "/api/config_templates/:id",
      "Update the default PXE menu on all configured TFTP servers": "/api/config_templates/build_pxe_default",
      "Clone a provision template": "/api/config_templates/:id/clone"
    },
    "common_parameters": {
      "List all global parameters": "/api/common_parameters",
      "Show a global parameter": "/api/common_parameters/:id",
      "Create a global parameter": "/api/common_parameters",
      "Update a global parameter": "/api/common_parameters/:id",
      "Delete a global parameter": "/api/common_parameters/:id"
    },
    "hosts": {
      "List all hosts": "/api/hosts",
      "Show a host": "/api/hosts/:id",
      "Create a host": "/api/hosts",
      "Update a host": "/api/hosts/:id",
      "Delete a host": "/api/hosts/:id",
      "Get ENC values of host": "/api/hosts/:id/enc",
      "Get configuration status of host": "/api/hosts/:id/status",
      "Get status of host": "/api/hosts/:id/status/:type",
      "Get vm attributes of host": "/api/hosts/:id/vm_compute_attributes",
      "Disassociate the host from a VM": "/api/hosts/:id/disassociate",
      "Run a power operation on host": "/api/hosts/:id/power",
      "Boot host from specified device": "/api/hosts/:id/boot",
      "Upload facts for a host, creating the host if required": "/api/hosts/facts",
      "Rebuild orchestration config": "/api/hosts/:id/rebuild_config",
      "Preview rendered provisioning template content": "/api/hosts/:id/template/:kind"
    },
    "interfaces": {
      "List all interfaces for host": "/api/hosts/:host_id/interfaces",
      "Show an interface for host": "/api/hosts/:host_id/interfaces/:id",
      "Create an interface on a host": "/api/hosts/:host_id/interfaces",
      "Update a host's interface": "/api/hosts/:host_id/interfaces/:id",
      "Delete a host's interface": "/api/hosts/:host_id/interfaces/:id"
    },
    "home": {
      "Show available API links": "/api",
      "Show status": "/api/status"
    },
    "usergroups": {
      "List all user groups": "/api/usergroups",
      "Show a user group": "/api/usergroups/:id",
      "Create a user group": "/api/usergroups",
      "Update a user group": "/api/usergroups/:id",
      "Delete a user group": "/api/usergroups/:id"
    },
    "tasks": {
      "List all tasks for a given orchestration event": "/api/orchestration/:id/tasks"
    },
    "ssh_keys": {
      "List all SSH keys for a user": "/api/users/:user_id/ssh_keys",
      "Show an SSH key from a user": "/api/users/:user_id/ssh_keys/:id",
      "Add an SSH key for a user": "/api/users/:user_id/ssh_keys",
      "Delete an SSH key for a user": "/api/users/:user_id/ssh_keys/:id"
    },
    "compute_profiles": {
      "List of compute profiles": "/api/compute_profiles",
      "Show a compute profile": "/api/compute_profiles/:id",
      "Create a compute profile": "/api/compute_profiles",
      "Update a compute profile": "/api/compute_profiles/:id",
      "Delete a compute profile": "/api/compute_profiles/:id"
    },
    "realms": {
      "List of realms": "/api/realms",
      "Show a realm": "/api/realms/:id",
      "Create a realm": "/api/realms",
      "Update a realm": "/api/realms/:id",
      "Delete a realm": "/api/realms/:id"
    },
    "environments": {
      "Import puppet classes from puppet proxy": "/api/smart_proxies/:id/import_puppetclasses",
      "List all environments": "/api/environments",
      "Show an environment": "/api/environments/:id",
      "Create an environment": "/api/environments",
      "Update an environment": "/api/environments/:id",
      "Delete an environment": "/api/environments/:id"
    },
    "parameters": {
      "List all parameters for a host": "/api/hosts/:host_id/parameters",
      "Show a nested parameter for a host": "/api/hosts/:host_id/parameters/:id",
      "Create a nested parameter for a host": "/api/hosts/:host_id/parameters",
      "Update a nested parameter for a host": "/api/hosts/:host_id/parameters/:id",
      "Delete a nested parameter for a host": "/api/hosts/:host_id/parameters/:id",
      "Delete all nested parameters for a host": "/api/hosts/:host_id/parameters"
    },
    "http_proxies": {
      "List of HTTP Proxies": "/api/http_proxies",
      "Show an HTTP Proxy": "/api/http_proxies/:id",
      "Create an HTTP Proxy": "/api/http_proxies",
      "Update an HTTP Proxy": "/api/http_proxies/:id",
      "Delete an HTTP Proxy": "/api/http_proxies/:id"
    },
    "subnets": {
      "List of subnets": "/api/subnets",
      "Show a subnet": "/api/subnets/:id",
      "Create a subnet": "/api/subnets",
      "Update a subnet": "/api/subnets/:id",
      "Delete a subnet": "/api/subnets/:id",
      "Provides an unused IP address in this subnet": "/api/subnets/:id/freeip"
    },
    "users": {
      "List all users": "/api/users",
      "Show a user": "/api/users/:id",
      "Create a user": "/api/users",
      "Update a user": "/api/users/:id",
      "Delete a user": "/api/users/:id"
    },
    "os_default_templates": {
      "List default templates combinations for an operating system": "/api/operatingsystems/:operatingsystem_id/os_default_templates",
      "Show a default template combination for an operating system": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id",
      "Create a default template combination for an operating system": "/api/operatingsystems/:operatingsystem_id/os_default_templates",
      "Update a default template combination for an operating system": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id",
      "Delete a default template combination for an operating system": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id"
    },
    "compute_attributes": {
      "Create a compute attributes set": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes",
      "Update a compute attributes set": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id"
    },
    "architectures": {
      "List all architectures": "/api/architectures",
      "Show an architecture": "/api/architectures/:id",
      "Create an architecture": "/api/architectures",
      "Update an architecture": "/api/architectures/:id",
      "Delete an architecture": "/api/architectures/:id"
    },
    "personal_access_tokens": {
      "List all Personal Access Tokens for a user": "/api/users/:user_id/personal_access_tokens",
      "Show a Personal Access Token for a user": "/api/users/:user_id/personal_access_tokens/:id",
      "Create a Personal Access Token for a user": "/api/users/:user_id/personal_access_tokens",
      "Revoke a Personal Access Token for a user": "/api/users/:user_id/personal_access_tokens/:id"
    },
    "config_groups": {
      "List of config groups": "/api/config_groups",
      "Show a config group": "/api/config_groups/:id",
      "Create a config group": "/api/config_groups",
      "Update a config group": "/api/config_groups/:id",
      "Delete a config group": "/api/config_groups/:id"
    },
    "provisioning_templates": {
      "List provisioning templates": "/api/provisioning_templates",
      "Show provisioning template details": "/api/provisioning_templates/:id",
      "Create a provisioning template": "/api/provisioning_templates",
      "Import a provisioning template": "/api/provisioning_templates/import",
      "Update a provisioning template": "/api/provisioning_templates/:id",
      "Delete a provisioning template": "/api/provisioning_templates/:id",
      "Update the default PXE menu on all configured TFTP servers": "/api/provisioning_templates/build_pxe_default",
      "Clone a provision template": "/api/provisioning_templates/:id/clone",
      "Export a provisioning template to ERB": "/api/provisioning_templates/:id/export"
    },
    "reports": {
      "List all reports": "/api/reports",
      "Show a report": "/api/reports/:id",
      "Create a report": "/api/reports",
      "Delete a report": "/api/reports/:id",
      "Show the last report for a host": "/api/hosts/:host_id/reports/last"
    },
    "settings": {
      "List all settings": "/api/settings",
      "Show a setting": "/api/settings/:id",
      "Update a setting": "/api/settings/:id"
    },
    "autosign": {
      "List all autosign entries": "/api/smart_proxies/smart_proxy_id/autosign",
      "Create autosign entry": "/api/smart_proxies/:smart_proxy_id/autosign",
      "Delete autosign entry": "/api/smart_proxies/:smart_proxy_id/autosign/:id"
    },
    "statistics": {
      "Get statistics": "/api/statistics"
    },
    "template_kinds": {
      "List all template kinds": "/api/template_kinds"
    },
    "operatingsystems": {
      "List all operating systems": "/api/operatingsystems",
      "Show an operating system": "/api/operatingsystems/:id",
      "Create an operating system": "/api/operatingsystems",
      "Update an operating system": "/api/operatingsystems/:id",
      "Delete an operating system": "/api/operatingsystems/:id",
      "List boot files for an operating system": "/api/operatingsystems/:id/bootfiles"
    },
    "domains": {
      "List of domains": "/api/domains",
      "Show a domain": "/api/domains/:id",
      "Create a domain": "/api/domains",
      "Update a domain": "/api/domains/:id",
      "Delete a domain": "/api/domains/:id"
    },
    "locations": {
      "List all locations": "/api/locations",
      "Show a location": "/api/locations/:id",
      "Create a location": "/api/locations",
      "Update a location": "/api/locations/:id",
      "Delete a location": "/api/locations/:id"
    },
    "auth_source_externals": {
      "List external authentication sources": "/api/auth_source_externals",
      "Show an external authentication source": "/api/auth_source_externals/:id",
      "Update an external authentication source": "/api/auth_source_externals/:id"
    },
    "audits": {
      "List all audits": "/api/audits",
      "Show an audit": "/api/audits/:id"
    },
    "override_values": {
      "List of override values for a specific smart variable": "/api/smart_variables/:smart_variable_id/override_values",
      "Show an override value for a specific smart variable": "/api/smart_variables/:smart_variable_id/override_values/:id",
      "Create an override value for a specific smart variable": "/api/smart_variables/:smart_variable_id/override_values",
      "Update an override value for a specific smart variable": "/api/smart_variables/:smart_variable_id/override_values/:id",
      "Delete an override value for a specific smart variable": "/api/smart_variables/:smart_variable_id/override_values/:id"
    },
    "auth_sources": {
      "List all authentication sources": "/api/auth_sources"
    },
    "mail_notifications": {
      "List of email notifications": "/api/mail_notifications",
      "Show an email notification": "/api/mail_notifications/:id"
    },
    "plugins": {
      "List installed plugins": "/api/plugins"
    },
    "dashboard": {
      "Get dashboard details": "/api/dashboard"
    },
    "auth_source_internals": {
      "List internal authentication sources": "/api/auth_source_internals",
      "Show an internal authentication source": "/api/auth_source_internals/:id"
    },
    "table_preferences": {
      "List of table preferences for a user": "/api/users/:user_id/table_preferences",
      "Table preference details of a given table": "/api/users/:user_id/table_preferences/:name",
      "Creates a table preference for a given table": "/api/users/:user_id/table_preferences",
      "Updates a table preference for a given table": "/api/users/:user_id/table_preferences/:name",
      "Delete a table preference for a given table": "/api/users/:user_id/table_preferences/:name"
    },
    "puppet_hosts": {
      "Force a Puppet agent run on the host": "/api/hosts/:id/puppetrun"
    }
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer