ProvisionController Resource

This controller is responsible for obtaining resources from cloud providers based the plan generated by the planner

DELETE /user/v1.0/provisioner/all

Security Roles Allowed
ADMIN
Response Body
media type data type
application/json string (JSON)
application/xml string (XML)

Example

Request
DELETE /user/v1.0/provisioner/all
Accept: application/json
Response
HTTP/1.1 204 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/provisioner/ids

Gets the IDs of all the stored ProvisionRequest

Security Roles Allowed
ADMIN, USER
Response Body
media type data type description
application/json array of string (JSON) a list of IDs
application/xml list of string (XML)

Example

Request
GET /user/v1.0/provisioner/ids
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...

POST /user/v1.0/provisioner/provision

Provison the resources specified by a plan.

Security Roles Allowed
ADMIN, USER
Request Body
media type data type
application/json ProvisionRequest (JSON)
application/xml provisionRequest (XML)
Response Body
media type data type description
application/json string (JSON) The ID of the provisioned ProvisionRequest
application/xml string (XML)

Example

Request
POST /user/v1.0/provisioner/provision
Content-Type: application/json
Accept: application/json

                
{
  "cloudCredentialsID" : "...",
  "planID" : "...",
  "publicKeyID" : "...",
  "keyValue" : {
    "property1" : { },
    "property2" : { }
  },
  "id" : "...",
  "owner" : "..."
}
Response
HTTP/1.1 201 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/provisioner/sample

Security Roles Allowed
ADMIN, USER
Response Body
media type data type
application/json ProvisionRequest (JSON)
application/xml provisionRequest (XML)

Example

Request
GET /user/v1.0/provisioner/sample
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
{
  "cloudCredentialsID" : "...",
  "planID" : "...",
  "publicKeyID" : "...",
  "keyValue" : {
    "property1" : { },
    "property2" : { }
  },
  "id" : "...",
  "owner" : "..."
}

DELETE /user/v1.0/provisioner/{id}

Deletes the ProvisionRequest

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path  
Response Body
media type data type description
application/json string (JSON) the ID of the deleted ProvisionRequest
application/xml string (XML)

Example

Request
DELETE /user/v1.0/provisioner/{id}
Accept: application/json
Response
HTTP/1.1 204 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/provisioner/{id}

Gets the ProvisionRequest

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path  
Response Body
media type data type description
application/json ProvisionResponse (JSON) the requested ProvisionRequest
application/xml provisionResponse (XML)

Example

Request
GET /user/v1.0/provisioner/{id}
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
{
  "deployParameters" : [ {
    "cloudCertificateName" : "...",
    "IP" : "...",
    "user" : "...",
    "role" : "..."
  }, {
    "cloudCertificateName" : "...",
    "IP" : "...",
    "user" : "...",
    "role" : "..."
  } ],
  "cloudCredentialsID" : "...",
  "planID" : "...",
  "publicKeyID" : "...",
  "keyValue" : {
    "property1" : { },
    "property2" : { }
  },
  "id" : "...",
  "owner" : "..."
}