PricingDedicated ServersVPS
API Reference
Signup

Deployment

This endpoint is used to handle product deployment actions.

  • Deployment - Start a new deployment
    • This is the first method to call when starting a deployment. After specifying the deployment name, a deployment ID will be supplied.
  • Deployment - Return a list with all client deployments
    • This method returns an array of all deployments on a client account including the name, order number, price, deployment ID, deployment configuration and provisioning status.
  • Deployment - Delete the specified deployment
    • This method will delete the deployment associated with the specified deployment ID.
  • Deployment - Return a dictionary with deployment information
    • This method returns details about the specified deployment ID including:
      • The deployment name
      • Order number
      • Price
      • Deployment ID
      • Deployment configuration
      • Provisioning status
  • Deployment - Receive product, quantity and options to be added on the deployment
    • This method updates the supplied deployment ID with such details as:
      • Operating system name or ID
      • The URL to download a custom iPXE script (If not supplying the script in its entirety)
      • The public SSH Key ID
      • The array of hostname strings
      • The product ID
      • The custom iPXE script (If not supplying the URL)
      • Any additional notes
      • The array of integers corresponding to options
      • The location code
      • Quantity
      • Billing period
      • The array of device ID integers to deploy or fail deployment
      • The array of ignition file IDs.
  • Deployment - Input a billing info id and script to process and finish a deployment
    • This method is used to add the billing info ID for payment and the Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows) to the specified deployment ID and wrap up the deployment process.