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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "registration": {
      "Render Global registration template": "/api/register",
      "Find or create a host and render the 'Host initial configuration' template": "/api/register"
    },
    "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 available vnic profiles for a compute resource, for oVirt only": "/api/compute_resources/:id/available_vnic_profiles",
      "List resource pools for a compute resource cluster": "/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools",
      "List attributes for a given storage domain": "/api/compute_resources/:id/storage_domains/:storage_domain_id",
      "List storage domains for a compute resource": "/api/compute_resources/:id/available_storage_domains",
      "List attributes for a given storage pod": "/api/compute_resources/:id/storage_pods/:storage_pod_id",
      "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",
      "List available virtual machines for a compute resource": "/api/compute_resources/:id/available_virtual_machines",
      "Show a virtual machine": "/api/compute_resources/:id/available_virtual_machines/:vm_id",
      "Power a Virtual Machine": "/api/compute_resources/:id/available_virtual_machines/:vm_id/power",
      "Delete a Virtual Machine": "/api/compute_resources/:id/available_virtual_machines/:vm_id"
    },
    "home": {
      "Show available API links": "/api",
      "Show status": "/api/status"
    }
  }
}

Params

Params