Intro and Quickstart

Learn how to use Private Cloud Director REST API

The Private Cloud Director API allows you to automate all your private cloud interactions and perform operations such as creating or updating virtual machines, downloading images, creating networks, creating storage volumes, and any other Private Cloud Director operation.

You can use the API to:

and a lot more, all using REST API calls.

1

Getting started

You will need a Private Cloud Director account to start with. If you don’t already have an account, you need to contact your Private Cloud Director administrator to get an account created. For users of Private Cloud Director community edition, use your community edition login credentials and account info that you received post installation.

2

Create an access token

After creating an account, you'll be able to create a personal access token using the Authentication method to get a token.

This token represents your user in Private Cloud Director, and allows you to make API calls, create or update virtual machines, storage volumes, networks, and any other objects, in any Private Cloud Director tenants that you're a part of, depending on your user role and privileges specific to the tenants.

Once you have your token, you are now ready to make your first API call

3

Make your first API call

The example below shows how to make an API call to list all virtual machines within a specific tenant.

curl -L \
  --url 'https://example.platform9.com/nova/v2.1/servers' \
  --header 'X-Auth-Token: YOUR_ACCESS_TOKEN' \
  --header 'Accept: */*'

Private Cloud Director API has many different API calls that allow you to interact with Private Cloud Director in different ways. After making your first API call, explore the API reference to review the different objects and API calls that you can make on those objects.

NextBlueprint

Last updated

Was this helpful?