Home

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"
    },
    "tasks": {
      "List all tasks for a given orchestration event": "/api/orchestration/:id/tasks"
    },
    "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"
    },
    "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 status of host": "/api/hosts/:id/status/:type",
      "Clear sub-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",
      "Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs": "/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"
    },
    "registration": {
      "Render Global registration template": "/api/register",
      "Find or create a host and render the Host registration template": "/api/register"
    },
    "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"
    },
    "template_combinations": {
      "List template combination": "/api/provisioning_templates/:provisioning_template_id/template_combinations",
      "Add a template combination": "/api/provisioning_templates/:provisioning_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"
    },
    "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"
    },
    "mail_notifications": {
      "List of email notifications": "/api/mail_notifications",
      "Show an email notification": "/api/mail_notifications/:id",
      "Add an email notification for a user": "/api/users/:user_id/mail_notifications",
      "Update an email notification for a user": "/api/users/:user_id/mail_notifications/:mail_notification_id",
      "Remove an email notification for a user": "/api/users/:user_id/mail_notifications/:mail_notification_id",
      "List all email notifications for a user": "/api/users/:user_id/mail_notifications"
    },
    "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"
    },
    "home": {
      "Show available API links": "/api",
      "Show status": "/api/status"
    }
  }
}

Params

Params