Product SiteDocumentation Site

Red Hat Enterprise Virtualization 3.6

REST API Guide

Using the Red Hat Enterprise Virtualization REST Application Programming Interface

Red Hat Enterprise Virtualization Documentation Team

Red Hat Customer Content Services

Abstract

This guide describes Red Hat Enterprise Virtualization's Representational State Transfer API.
1. Introduction
1.1. Representational State Transfer
1.2. Red Hat Enterprise Virtualization REST API Prerequisites
2. Authentication and Security
2.1. TLS/SSL Certification
2.2. HTTP Authentication
2.3. Authentication Sessions
3. REST API Quick Start Example
3.1. Example: Access API Entry Point
3.2. Example: List Data Center Collection
3.3. Example: List Host Cluster Collection
3.4. Example: List Logical Networks Collection
3.5. Example: List Host Collection
3.6. Example: List CPU Profiles
3.7. Example: Approve Host
3.8. Example: Create NFS Data Storage
3.9. Example: Create NFS ISO Storage
3.10. Example: Attach Storage Domains to Data Center
3.11. Example: Activate Storage Domains
3.12. Example: Create Virtual Machine
3.13. Example: Create Virtual Machine NIC
3.14. Example: Create Virtual Machine Storage Disk
3.15. Example: Attach ISO Image to Virtual Machine
3.16. Example: Start Virtual Machine
3.17. Example: Check System Events
4. Entry Point
4.1. Product Information
4.2. Link Elements
4.3. Special Object Elements
4.4. Summary Element
4.5. RESTful Service Description Language (RSDL)
4.6. Red Hat Enterprise Virtualization Windows Guest VSS Support
4.7. QEMU Guest Agent Overview
4.8. VSS Transaction Flow
5. Compatibility Level Versions
5.1. Upgrading Compatibility Levels
6. Capabilities
6.1. Version-Dependent Capabilities
6.2. Current Version
6.3. Features
7. Common Features
7.1. Element Property Icons
7.2. Representations
7.3. Collections
7.4. Resources
8. The Backup and Restore API
8.1. Backing Up a Virtual Machine
8.2. Restoring a Virtual Machine
9. Data Centers
9.1. Data Center Elements
9.2. XML Representation of a Data Center
9.3. JSON Representation of a Data Center
9.4. Methods
9.5. Sub-Collections
9.6. Actions
10. Clusters
10.1. Cluster Elements
10.2. Memory Policy Elements
10.3. Scheduling Policy Elements
10.4. XML Representation of a Cluster
10.5. JSON Representation of a Cluster
10.6. Methods
10.7. Sub-Collections
11. Networks
11.1. Network Elements
11.2. XML Representation of a Network Resource
11.3. JSON Representation of a Network Resource
11.4. Methods
11.5. Sub-collections
12. Storage Domains
12.1. Storage Domain Elements
12.2. XML Representation of a Storage Domain
12.3. JSON Representation of a Storage Domain
12.4. Methods
12.5. Storage Types
12.6. Export Storage Domains
12.7. Glance Image Storage Domains
12.8. Importing a Block Storage Domain
12.9. Sub-Collections
12.10. Actions
13. Storage Connections
13.1. Storage Connection Elements
13.2. XML representation of a Storage Connection Resource
13.3. Methods
14. Hosts
14.1. Host Elements
14.2. XML Representation of a Host
14.3. JSON Representation of a Host
14.4. Power Management Elements
14.5. Memory Management Elements
14.6. Methods
14.7. Sub-Collections
14.8. Actions
15. Virtual Machines
15.1. Virtual Machine Elements
15.2. XML Representation of a Virtual Machine
15.3. XML Representation of Additional OVF Data for a Virtual Machine
15.4. JSON Representation of a Virtual Machine
15.5. Methods
15.6. Sub-Collections
15.7. Actions
16. Floating Disks
16.1. Floating Disk Elements
16.2. XML Representation of a Floating Disk
16.3. Methods
16.4. Sub-Collections
16.5. Actions
17. Templates
17.1. Virtual Machine Template Elements
17.2. XML Representation of a Virtual Machine Template
17.3. Methods
17.4. Actions
18. Virtual Machine Pools
18.1. Virtual Machine Pool Elements
18.2. XML Representation of a Virtual Machine Pool
18.3. Methods
18.4. Actions
19. Domains
19.1. Domain Elements
19.2. XML Representation of a Domain Resource
19.3. Sub-Collections
20. Groups
20.1. Imported Group Elements
20.2. XML Representation of a Group Resource
20.3. Adding a Group from a Directory Service
21. Roles
21.1. Role Elements
21.2. XML Representation of the Roles Collection
21.3. Methods
21.4. Roles Permits Sub-Collection
22. Users
22.1. User Elements
22.2. XML representation of a User Resource
22.3. Methods
23. MAC Address Pools
23.1. MAC Address Pool Elements
23.2. XML Representation of the MAC Address Pools Collection
23.3. Methods
24. Tags
24.1. Tag Elements
24.2. XML Representation of a Tag Resource
24.3. Associating Tags
24.4. Parent Tags
25. Events
25.1. Event Elements
25.2. XML Representation of the Events Collection
25.3. XML Representation of a Virtual Machine Creation Event
25.4. Methods
A. API Usage with cURL
A.1. API Usage with cURL
A.2. Installing cURL
A.3. Using cURL
A.4. Examples
B. Enumerated Value Translation
B.1. Enumerated Value Translation
C. Event Codes
C.1. Event Codes
D. Timezones
D.1. Timezones
E. Revision History