Product SiteDocumentation Site

Apache CloudStack 4.0.1-incubating

CloudStack API Developer's Guide


Apache CloudStack

Legal Notice

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Apache CloudStack is an effort undergoing incubation at The Apache Software Foundation (ASF).
Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
How to integrate with CloudStack using the CloudStack API.

1. Concepts
1.1. What Is CloudStack?
1.2. What Can CloudStack Do?
1.3. Deployment Architecture Overview
1.3.1. Management Server Overview
1.3.2. Cloud Infrastructure Overview
1.3.3. Networking Overview
2. Introduction for Developers
2.1. Roles
2.2. API Reference Documentation
2.3. Getting Started
3. What's New in the API?
3.1. What's New in the API for 4.0
3.1.1. Changed API Commands in 4.0.0-incubating
3.1.2. Added API Commands in 4.0.0-incubating
3.2. What's New in the API for 3.0
3.2.1. Enabling Port 8096
3.2.2. Stopped VM
3.2.3. Change to Behavior of List Commands
3.2.4. Removed API commands
3.2.5. Added API commands in 3.0
3.2.6. Added CloudStack Error Codes
4. Calling the CloudStack API
4.1. Making API Requests
4.2. Enabling API Call Expiration
4.3. Signing API Requests
4.4. Responses
4.4.1. Response Formats: XML and JSON
4.4.2. Maximum Result Pages Returned
4.4.3. Error Handling
4.5. Asynchronous Commands
4.5.1. Job Status
4.5.2. Example
5. Working With Usage Data
5.1. Usage Record Format
5.1.1. Virtual Machine Usage Record Format
5.1.2. Network Usage Record Format
5.1.3. IP Address Usage Record Format
5.1.4. Disk Volume Usage Record Format
5.1.5. Template, ISO, and Snapshot Usage Record Format
5.1.6. Load Balancer Policy or Port Forwarding Rule Usage Record Format
5.1.7. Network Offering Usage Record Format
5.1.8. VPN User Usage Record Format
5.2. Usage Types
5.3. Example response from listUsageRecords
5.4. Dates in the Usage Record
A. Event Types
B. Alerts
C. Time Zones
D. Revision History