Blueprint

List all blueprints

get

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Responses

200

Successfully retrieved blueprints

application/json

get

/blueprint

HTTPcURLJavaScriptPython

GET /resmgr/v2/blueprint HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

200

Successfully retrieved blueprints

[
  {
    "name": "default",
    "networkingType": "ovn",
    "enableDistributedRouting": true,
    "dnsDomainName": "localdomain",
    "virtualNetworking": {
      "enabled": true,
      "underlayType": "vlan",
      "vnidRange": "1:1000"
    },
    "vmHighAvailability": {
      "enabled": false
    },
    "autoResourceRebalancing": {
      "enabled": false,
      "rebalancingStrategy": "vm_workload_consolidation",
      "rebalancingFrequencyMins": 20
    },
    "imageLibraryStorage": "/var/lib/images|lvm",
    "vmStorage": "/var/lib/instances",
    "storageBackends": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {
          "driver": "NetApp",
          "config": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    }
  }
]

Create a new blueprint

post

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Body

application/json

namestringRequired

Cluster name

Example: default

networkingTypestring · enumOptional

Defaults to OVN

Default: ovnPossible values:

enableDistributedRoutingbooleanOptional

Enable Cluster Wide Distributed Network Routing

Default: true

dnsDomainNamestringOptional

DNS Domain Name

Example: localdomain

imageLibraryStoragestringOptional

Library location on filesystem or Cinder volume type

Example: /var/lib/images|lvm

vmStoragestringOptional

Ephemeral Virtual Machine storage path

Example: /var/lib/instances

Responses

204

Operation successful

400

Invalid request

409

Operation cannot be performed in current state

application/json

post

/blueprint

HTTPcURLJavaScriptPython

POST /resmgr/v2/blueprint HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 561

{
  "name": "default",
  "networkingType": "ovn",
  "enableDistributedRouting": true,
  "dnsDomainName": "localdomain",
  "virtualNetworking": {
    "enabled": true,
    "underlayType": "vlan",
    "vnidRange": "1:1000"
  },
  "vmHighAvailability": {
    "enabled": false
  },
  "autoResourceRebalancing": {
    "enabled": false,
    "rebalancingStrategy": "vm_workload_consolidation",
    "rebalancingFrequencyMins": 20
  },
  "imageLibraryStorage": "/var/lib/images|lvm",
  "vmStorage": "/var/lib/instances",
  "storageBackends": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "driver": "NetApp",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  }
}

No content

Retrieve a specific blueprint

get

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

clusterNamestringRequired

Responses

200

Successfully retrieved blueprint

application/json

ResponsestringDefault: null

404

Resource not found

get

/blueprint/{clusterName}

HTTPcURLJavaScriptPython

GET /resmgr/v2/blueprint/{clusterName} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

null

Update an existing blueprint

put

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

clusterNamestringRequired

Body

application/json

namestringRequired

Cluster name

Example: default

networkingTypestring · enumOptional

Defaults to OVN

Default: ovnPossible values:

enableDistributedRoutingbooleanOptional

Enable Cluster Wide Distributed Network Routing

Default: true

dnsDomainNamestringOptional

DNS Domain Name

Example: localdomain

imageLibraryStoragestringOptional

Library location on filesystem or Cinder volume type

Example: /var/lib/images|lvm

vmStoragestringOptional

Ephemeral Virtual Machine storage path

Example: /var/lib/instances

Responses

204

Operation successful

404

Resource not found

put

/blueprint/{clusterName}

HTTPcURLJavaScriptPython

PUT /resmgr/v2/blueprint/{clusterName} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 561

{
  "name": "default",
  "networkingType": "ovn",
  "enableDistributedRouting": true,
  "dnsDomainName": "localdomain",
  "virtualNetworking": {
    "enabled": true,
    "underlayType": "vlan",
    "vnidRange": "1:1000"
  },
  "vmHighAvailability": {
    "enabled": false
  },
  "autoResourceRebalancing": {
    "enabled": false,
    "rebalancingStrategy": "vm_workload_consolidation",
    "rebalancingFrequencyMins": 20
  },
  "imageLibraryStorage": "/var/lib/images|lvm",
  "vmStorage": "/var/lib/instances",
  "storageBackends": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "driver": "NetApp",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  }
}

No content

Delete a specific blueprint

delete

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

clusterNamestringRequired

Responses

204

Operation successful

404

Resource not found

delete

/blueprint/{clusterName}

HTTPcURLJavaScriptPython

DELETE /resmgr/v2/blueprint/{clusterName} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

No content

Assign role to the host or update role settings

put

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostIdstringRequired

roleNameundefined · enumRequiredPossible values:

Body

application/json

backendsstring[]Required

List of storage backends to associate with the role

Responses

200

Role assigned successfully

No content

400

Invalid request

404

Resource not found

409

Operation cannot be performed in current state

application/json

put

/hosts/{hostId}/roles/{roleName}

HTTPcURLJavaScriptPython

PUT /resmgr/v2/hosts/{hostId}/roles/{roleName} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "backends": [
    "text"
  ]
}

No content

Remove role from the host

delete

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostIdstringRequired

roleNameundefined · enumRequiredPossible values:

Responses

204

Role unassigned successfully

400

Invalid request

404

Resource not found

delete

/hosts/{hostId}/roles/{roleName}

HTTPcURLJavaScriptPython

DELETE /resmgr/v2/hosts/{hostId}/roles/{roleName} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

No content

List host configurations

get

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Responses

200

List of host configurations

application/json

get

/hostconfigs

HTTPcURLJavaScriptPython

GET /resmgr/v2/hostconfigs HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

200

List of host configurations

[
  {
    "name": "Hypervisor-002",
    "mgmtInterface": "ens3",
    "vmConsoleInterface": "ens3",
    "hostLivenessInterface": "ens3",
    "tunnelingInterface": "ens3",
    "imagelibInterface": "eth0",
    "networkLabels": {
      "physnet": "ens3"
    },
    "clusterName": "default",
    "id": "17e20369-0c70-4e33-b018-b361cad83cf5"
  }
]

Create host configuration(s)

post

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Body

application/json

or

Responses

200

Host configuration(s) created

application/json

409

Operation cannot be performed in current state

application/json

post

/hostconfigs

HTTPcURLJavaScriptPython

POST /resmgr/v2/hostconfigs HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "name": "Hypervisor-002",
  "mgmtInterface": "ens3",
  "vmConsoleInterface": "ens3",
  "hostLivenessInterface": "ens3",
  "tunnelingInterface": "ens3",
  "imagelibInterface": "eth0",
  "networkLabels": {
    "physnet": "ens3"
  },
  "clusterName": "default"
}

[
  {
    "name": "Hypervisor-002",
    "mgmtInterface": "ens3",
    "vmConsoleInterface": "ens3",
    "hostLivenessInterface": "ens3",
    "tunnelingInterface": "ens3",
    "imagelibInterface": "eth0",
    "networkLabels": {
      "physnet": "ens3"
    },
    "clusterName": "default",
    "id": "17e20369-0c70-4e33-b018-b361cad83cf5"
  }
]

Get host configuration

get

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostConfigIdstringRequired

Responses

200

Host configuration details

application/json

get

/hostconfigs/{hostConfigId}

HTTPcURLJavaScriptPython

GET /resmgr/v2/hostconfigs/{hostConfigId} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

200

Host configuration details

{
  "name": "Hypervisor-002",
  "mgmtInterface": "ens3",
  "vmConsoleInterface": "ens3",
  "hostLivenessInterface": "ens3",
  "tunnelingInterface": "ens3",
  "imagelibInterface": "eth0",
  "networkLabels": {
    "physnet": "ens3"
  },
  "clusterName": "default",
  "id": "17e20369-0c70-4e33-b018-b361cad83cf5"
}

Update host configuration

put

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostConfigIdstringRequired

Body

application/json

namestringOptionalExample: Hypervisor-002

mgmtInterfacestringOptionalExample: ens3

vmConsoleInterfacestringOptionalExample: ens3

hostLivenessInterfacestringOptionalExample: ens3

tunnelingInterfacestringOptionalExample: ens3

imagelibInterfacestringOptionalExample: eth0

networkLabelsobjectOptionalExample: {"physnet":"ens3"}

clusterNamestringOptionalExample: default

Responses

200

Host configuration updated

application/json

put

/hostconfigs/{hostConfigId}

HTTPcURLJavaScriptPython

PUT /resmgr/v2/hostconfigs/{hostConfigId} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "name": "Hypervisor-002",
  "mgmtInterface": "ens3",
  "vmConsoleInterface": "ens3",
  "hostLivenessInterface": "ens3",
  "tunnelingInterface": "ens3",
  "imagelibInterface": "eth0",
  "networkLabels": {
    "physnet": "ens3"
  },
  "clusterName": "default"
}

200

Host configuration updated

{
  "name": "Hypervisor-002",
  "mgmtInterface": "ens3",
  "vmConsoleInterface": "ens3",
  "hostLivenessInterface": "ens3",
  "tunnelingInterface": "ens3",
  "imagelibInterface": "eth0",
  "networkLabels": {
    "physnet": "ens3"
  },
  "clusterName": "default",
  "id": "17e20369-0c70-4e33-b018-b361cad83cf5"
}

Delete host configuration

delete

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostConfigIdstringRequired

Responses

204

Host configuration deleted

delete

/hostconfigs/{hostConfigId}

HTTPcURLJavaScriptPython

DELETE /resmgr/v2/hostconfigs/{hostConfigId} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

204

Host configuration deleted

No content

Assign host configuration to host

put

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostIdstringRequired

hostConfigIdstringRequired

Responses

200

Host configuration assigned

No content

put

/hosts/{hostId}/hostconfig/{hostConfigId}

HTTPcURLJavaScriptPython

PUT /resmgr/v2/hosts/{hostId}/hostconfig/{hostConfigId} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

200

Host configuration assigned

No content

Unassign host configuration from host

delete

Authorizations

TokenAuth

x-auth-tokenstringRequired

Keystone Authentication token

Path parameters

hostIdstringRequired

hostConfigIdstringRequired

Responses

204

Host configuration unassigned

delete

/hosts/{hostId}/hostconfig/{hostConfigId}

HTTPcURLJavaScriptPython

DELETE /resmgr/v2/hosts/{hostId}/hostconfig/{hostConfigId} HTTP/1.1
Host: example.platform9.com
x-auth-token: YOUR_API_KEY
Accept: */*

204

Host configuration unassigned

No content