Get a cost estimate for a virtual machine

POST

https://api.americancloud.com/api/v1/compute/vms/cost-estimate

POST

/api/v1/compute/vms/cost-estimate

curl -X POST https://api.americancloud.com/api/v1/compute/vms/cost-estimate \
     -H "X-API-Client-ID: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "my-new-vm",
  "region": "us-west-0",
  "vmPackage": "standard-custom",
  "vmSpecs": {
    "vcpu": 2,
    "memoryMb": 2048,
    "rootDiskGb": 50
  },
  "image": "ubuntu-22.04",
  "subscriptionPeriod": "hourly"
}'

{
  "estimates": {
    "hourly": {
      "base": 36,
      "discount": 7.2,
      "total": 28.8,
      "prorated": {
        "days_remaining": 15,
        "amount": 14.4
      }
    },
    "monthly": {
      "base": 36,
      "discount": 7.2,
      "total": 28.8,
      "prorated": {
        "days_remaining": 15,
        "amount": 14.4
      }
    }
  },
  "discount_applied": {
    "name": "20% off VMs",
    "percent": 20,
    "resource_types": [
      "Virtual Machine",
      "Block Storage"
    ]
  },
  "billing_note": "Nothing is charged now. Usage appears on your monthly bill, with a minimum of $5/month for 250 GB, prorated for your first partial month.",
  "metered": {
    "rate_per_gb_month": {
      "base": 36,
      "discount": 7.2,
      "total": 28.8,
      "prorated": {
        "days_remaining": 15,
        "amount": 14.4
      }
    },
    "minimum_gb": 250
  }
}

Returns the estimated cost for a VM with the given specs without creating it. Accepts the same body as create.

Authentication

X-API-Client-IDstring

API Client ID

X-API-Client-Secretstring

API Client Secret

Request

This endpoint expects an object.

namestringRequiredformat: "^[a-zA-Z](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$"1-63 characters

VM name. It must be 1 to 63 characters, start with a letter, end with a letter or a digit, and hold only letters, digits and hyphens.

regionstringRequired

Region label

vmPackagestringRequired

VM package label

vmSpecsobjectRequired

VM specifications

imagestringRequired

Image label to use for the VM

subscriptionPeriodenumRequired

Subscription period

Allowed values:

networkstringOptionalformat: "uuid"

UUID of a pre-existing network to attach the VM to. Omit to have an isolated network auto-created for the VM (post-create access is then configured via networkAccess). An auto-created network is deleted with the VM once its last VM is removed; a network you supply is not.

tagslist of stringsOptional

List of tags to add to the VM

keypairslist of stringsOptional

Names of SSH key pairs to use (optional)

userdatastringOptional

Base64-encoded cloud-init userdata script (optional)

networkAccessobjectOptional

Optional network access configuration applied after the VM is created. Only honored when no network is provided (i.e. an isolated network is auto-created). Applies the requested outbound traffic setting and adds port forwarding + firewall rules for the requested inbound ports against the network’s public IP.

Response

Cost estimate for the virtual machine

estimatesobject

Cost estimates for the resource

discount_appliedobjectOptional

Discount applied to the estimate (if any)

billing_notestringOptional

Additional billing information or notes about pricing structure

meteredobjectOptional

The usage rate, for a resource that is billed by usage (object storage only).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error