API Reference

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/account/info

Example Response:

{
"balance": "-5519.11",
"pending_charges": "57.03",
"last_payment_date": "2014-07-18 15:31:01",
"last_payment_amount": "-1.00"
}

Parameters:

No parameters.

Example Request:

curl https://api.vultr.com/v1/app/list

Example Response:

{
"1": {
"APPID": "1",
"name": "LEMP",
"short_name": "lemp",
"deploy_name": "LEMP on CentOS 6 x64",
"surcharge": 0.00
},
"2": {
"APPID": "2",
"name": "WordPress",
"short_name": "wordpress",
"deploy_name": "WordPress on CentOS 6 x64",
"surcharge": 0.00
}
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/auth/info

Example Response:

{
"acls": [
"subscriptions",
"billing",
"support",
"provisioning"
],
"email": "example@vultr.com",
"name": "Example Account"
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/backup/list

Example Response:

{
"543d34149403a": {
"BACKUPID": "543d34149403a",
"date_created": "2014-10-14 12:40:40",
"description": "Automatic server backup",
"size": "42949672960",
"status": "complete"
},
"543d340f6dbce": {
"BACKUPID": "543d340f6dbce",
"date_created": "2014-10-13 16:11:46",
"description": "",
"size": "10000000",
"status": "complete"
}
}

Parameters:

SUBID integer (optional) Filter result set to only contain backups of this subscription object.
BACKUPID string (optional) Filter result set to only contain this backup.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/app_change --data 'SUBID=900000' --data 'APPID=2'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.
APPID integer Application to use. See /v1/baremetal/app_change_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/app_change_list?SUBID=900000

Example Response:

{
"1": {
"APPID": "1",
"name": "LEMP",
"short_name": "lemp",
"deploy_name": "LEMP on CentOS 6 x64",
"surcharge": 0.00
},
"2": {
"APPID": "2",
"name": "WordPress",
"short_name": "wordpress",
"deploy_name": "WordPress on CentOS 6 x64",
"surcharge": 0.00
}
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/bandwidth?SUBID=900000

Example Response:

{
"incoming_bytes": [
[ "2017-04-01", 91571055 ],
[ "2017-04-02", 78355758 ],
[ "2017-04-03", 85827590 ]
],
"outgoing_bytes": [
[ "2017-04-01", 3084731 ],
[ "2017-04-02", 1810478 ],
[ "2017-04-03", 2729604 ]
]
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/create --data 'DCID=1' --data 'METALPLANID=1' --data 'OSID=127'

Example Response:

{
"SUBID": "900000"
}

Parameters:

DCID integer Location in which to create the server. See v1/regions/list.
METALPLANID integer Plan to use when creating this server. See v1/plans/list_baremetal.
OSID integer Operating system to use. See v1/os/list.
SCRIPTID integer (optional) The SCRIPTID of a startup script to execute on boot. This only works when using a Vultr supplied operating system. See v1/startupscript/list.
SNAPSHOTID string (optional) If you've selected the 'snapshot' operating system, this should be the SNAPSHOTID (see v1/snapshot/list) to restore for the initial installation.
enable_ipv6 string (optional) 'yes' or 'no'.  If yes, an IPv6 subnet will be assigned to the server.
label string (optional) This is a text label that will be shown in the control panel.
SSHKEYID string (optional) List of SSH keys to apply to this server on install (only valid for Linux/FreeBSD). See v1/sshkey/list. Separate keys with commas.
APPID integer (optional) If launching an application (OSID 186), this is the APPID to launch. See v1/app/list.
userdata string (optional) Base64 encoded user-data.
notify_activate string (optional, default 'yes') 'yes' or 'no'. If yes, an activation email will be sent when the server is ready.
hostname string (optional) The hostname to assign to this server.
tag string (optional) The tag to assign to this server.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/destroy --data 'SUBID=900000'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/get_app_info?SUBID=900000

Example Response:

{
"app_info": ""
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/get_user_data?SUBID=900000

Example Response:

{
"userdata": "ZWNobyBIZWxsbyBXb3JsZA=="
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/halt --data 'SUBID=900000'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/ipv6_enable --data 'SUBID=900000'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/label_set --data 'SUBID=900000' --data 'label=example'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.
label string This is a text label that will be shown in the control panel.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/list

Example Response:

{
"900000": {
"SUBID": "900000",
"os": "CentOS 6 x64",
"ram": "65536 MB",
"disk": "2x 240 GB SSD",
"main_ip": "203.0.113.10",
"cpu_count": 1,
"location": "New Jersey",
"DCID": "1",
"default_password": "ab81u!ryranq",
"date_created": "2017-04-12 18:45:41",
"status": "active",
"netmask_v4": "255.255.255.0",
"gateway_v4": "203.0.113.1",
"METALPLANID": 28,
"v6_networks": [{
"v6_network": "2001:DB8:9000::",
"v6_main_ip": "2001:DB8:9000::100",
"v6_network_size": 64
}],
"label": "my label",
"tag": "my tag",
"OSID": "127",
"APPID": "0"
}
}

Parameters:

SUBID integer (optional) Unique identifier of a subscription. Only the subscription object will be returned.
tag string (optional) A tag string. Only subscription objects with this tag will be returned.
label string (optional) A text label string. Only subscription objects with this text label will be returned.
main_ip string (optional) An IPv4 address. Only the subscription matching this IPv4 address will be returned.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/list_ipv4?SUBID=900000

Example Response:

{
"900000": [
{
"ip": "203.0.113.10",
"netmask": "255.255.255.0",
"gateway": "203.0.113.1",
"type": "main_ip"
}
]
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/list_ipv6?SUBID=900000

Example Response:

{
"900000": [
{
"ip": "2001:DB8:9000::100",
"network": "2001:DB8:9000::",
"network_size": 64,
"type": "main_ip"
}
]
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/os_change --data 'SUBID=900000' --data 'OSID=127'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.
OSID integer Operating system to use. See /v1/baremetal/os_change_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/os_change_list?SUBID=900000

Example Response:

{
"127": {
"OSID": "127",
"name": "CentOS 6 x64",
"arch": "x64",
"family": "centos",
"windows": false,
"surcharge": 0.00
},
"148": {
"OSID": "148",
"name": "Ubuntu 12.04 i386",
"arch": "i386",
"family": "ubuntu",
"windows": false,
"surcharge": 0.00
}
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/reboot --data 'SUBID=900000'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/reinstall --data 'SUBID=900000'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/set_user_data --data 'SUBID=900000' --data 'userdata=ZWNobyBIZWxsbyBXb3JsZA=='

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.
userdata string Base64 encoded user-data

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/baremetal/tag_set --data 'SUBID=900000' --data 'tag=Web'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/baremetal/list call.
tag string The tag to assign to this server. This tag is shown in the control panel.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/attach --data 'SUBID=1313217' --data 'attach_to_SUBID=1313207'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer ID of the block storage subscription to attach
attach_to_SUBID integer ID of the VPS subscription to mount the block storage subscription to

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/create --data 'DCID=1' --data 'size_gb=50' --data 'label=test'

Example Response:

{
"SUBID": "1313217"
}

Parameters:

DCID integer DCID of the location to create this subscription in.  See /v1/regions/list
size_gb integer Size (in GB) of this subscription.
label string (optional) Text label that will be associated with the subscription

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/delete --data 'SUBID=1313217'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer ID of the block storage subscription to delete

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/detach --data 'SUBID=1313217'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer ID of the block storage subscription to detach

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/label_set --data 'SUBID=1313217' --data 'label=example'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer ID of the block storage subscription.
label string Text label that will be shown in the control panel.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/list

Example Response:

[
{
"SUBID": 1313216,
"date_created": "2016-03-29 10:10:04",
"cost_per_month": 10.00,
"status": "pending",
"size_gb": 100,
"DCID": 1,
"attached_to_SUBID": null,
"label": "files1"
},
{
"SUBID": 1313217,
"date_created": "2016-31-29 10:10:48",
"cost_per_month": 5.00,
"status": "active",
"size_gb": 50,
"DCID": 1,
"attached_to_SUBID": 1313207,
"label": "files2"
}
]

Parameters:

SUBID integer (optional) Unique identifier of a subscription. Only the subscription object will be returned.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/block/resize --data 'SUBID=1313217' --data 'size_gb=75'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer ID of the block storage subscription to resize
size_gb integer New size (in GB) of the block storage subscription

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/create_domain --data 'domain=example.com' --data 'serverip=127.0.0.1'

Example Response:

Parameters:

domain string Domain name to create
serverip string Server IP to use when creating default records (A and MX)

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/create_record --data 'domain=example.com' --data 'name=vultr' --data 'type=A' --data 'data=192.0.2.1'

Example Response:

Parameters:

domain string Domain name to add record to
name string Name (subdomain) of record
type string Type (A, AAAA, MX, etc) of record
data string Data for this record
ttl integer (optional) TTL of this record
priority integer (only required for MX and SRV) Priority of this record (omit the priority from the data)

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/delete_domain --data 'domain=example.com'

Example Response:

No response, check HTTP result code.

Parameters:

domain string Domain name to delete

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/delete_record --data 'domain=example.com' --data 'RECORDID=1265277'

Example Response:

Parameters:

domain string Domain name to delete record from
RECORDID integer ID of record to delete (see /dns/records)

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/dnssec_enable --data 'domain=example.com' --data 'enable=yes'

Example Response:

No response, check HTTP result code.

Parameters:

domain string Domain name to update record
enable string 'yes' or 'no'.  If yes, DNSSEC will be enabled for the given domain

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/dnssec_info?domain=example.com

Example Response:

[
"example.com IN DNSKEY 257 3 13 kRrxANp7YTGqVbaWtMy8hhsK0jcG4ajjICZKMb4fKv79Vx/RSn76vNjzIT7/Uo0BXil01Fk8RRQc4nWZctGJBA==",
"example.com IN DS 27933 13 1 2d9ac457e5c11a104e25d971d0a6254562bddde7",
"example.com IN DS 27933 13 2 8858e7b0dfb881280ce2ca1e0eafcd93d5b53687c21da284d4f8799ba82208a9"
]

Parameters:

domain string Domain from which to gather DNSSEC keys.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/list

Example Response:

[
{
"domain": "example.com",
"date_created": "2014-12-11 16:20:59"
}
]

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/records?domain=example.com

Example Response:

[
{
"type": "A",
"name": "",
"data": "127.0.0.1",
"priority": 0,
"RECORDID": 1265276,
"ttl": 300
},
{
"type": "CNAME",
"name": "*",
"data": "example.com",
"priority": 0,
"RECORDID": 1265277,
"ttl": 300
}
]

Parameters:

domain string Domain to list records for

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/soa_info?domain=example.com

Example Response:

{
"nsprimary": "ns1.vultr.com",
"email": "dnsadm@vultr.com"
}

Parameters:

domain string Domain from which to gather SOA information

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/soa_update --data 'domain=example.com' --data 'nsprimary=ns1.vultr.com' --data 'email=admin@example.com'

Example Response:

No response, check HTTP result code.

Parameters:

domain string Domain name to update record
nsprimary string (Optional) Primary nameserver to store in the SOA record
email string (Optional) Administrative email to store in the SOA record

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/dns/update_record --data 'domain=example.com' --data 'RECORDID=1265277' --data 'name=vultr' --data 'type=A' --data 'data=127.0.0.1'

Example Response:

No response, check HTTP result code.

Parameters:

domain string Domain name to update record
RECORDID integer ID of record to update (see /dns/records)
name string (optional) Name (subdomain) of record
data string (optional) Data for this record
ttl integer (optional) TTL of this record
priority integer (optional) (only required for MX and SRV) Priority of this record (omit the priority from the data)

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/firewall/group_create --data 'description=group1'

Example Response:

{
"FIREWALLGROUPID": "1234abcd"
}

Parameters:

description string (optional) Description of firewall group.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/firewall/group_delete --data 'FIREWALLGROUPID=1234abcd'

Example Response:

No response, check HTTP result code.

Parameters:

FIREWALLGROUPID string Firewall group to delete.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/firewall/group_list

Example Response:

{
"1234abcd": {
"FIREWALLGROUPID": "1234abcd",
"description": "my http firewall",
"date_created": "2017-02-14 17:48:40",
"date_modified": "2017-02-14 17:48:40",
"instance_count": 2,
"rule_count": 2,
"max_rule_count": 50
}
}

Parameters:

FIREWALLGROUPID string (optional) Filter result set to only contain this firewall group.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/firewall/group_set_description --data 'FIREWALLGROUPID=1234abcd' --data 'description=group2'

Example Response:

No response, check HTTP result code.

Parameters:

FIREWALLGROUPID string Firewall group to update.
description string Description of firewall group.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/firewall/rule_create --data 'FIREWALLGROUPID=1234abcd' --data 'direction=in' --data 'ip_type=v4' --data 'protocol=tcp' --data 'subnet=10.234.22.0' --data 'subnet_size=24' --data 'port=80' --data 'notes=example text'

Example Response:

{
"rulenumber": 2
}

Parameters:

FIREWALLGROUPID string Target firewall group. See /v1/firewall/group_list.
direction string Direction of rule. Possible values: "in".
ip_type string IP address type. Possible values: "v4", "v6".
protocol string Protocol type. Possible values: "icmp", "tcp", "udp", "gre".
subnet string IP address representing a subnet. The IP address format must match with the "ip_type" parameter value.
subnet_size integer IP prefix size in bits.
port string (optional) TCP/UDP only. This field can be an integer value specifying a port or a colon separated port range.
notes string (optional) This field supports notes up to 255 characters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/firewall/rule_delete --data 'FIREWALLGROUPID=1234abcd' --data 'rulenumber=2'

Example Response:

No response, check HTTP result code.

Parameters:

FIREWALLGROUPID string Target firewall group. See /v1/firewall/group_list.
rulenumber integer Rule number to delete. See /v1/firewall/rule_list.

Example Request:

curl -H 'API-Key: YOURKEY' 'https://api.vultr.com/v1/firewall/rule_list?FIREWALLGROUPID=1234abcd&direction=in&ip_type=v4'

Example Response:

{
"1": {
"rulenumber": 1,
"action": "accept",
"protocol": "icmp",
"port": "",
"subnet": "",
"subnet_size": 0,
"notes": ""
},
"2": {
"rulenumber": 2,
"action": "accept",
"protocol": "tcp",
"port": "80",
"subnet": "10.234.22.0",
"subnet_size": 24,
"notes": "example"
}
}

Parameters:

FIREWALLGROUPID string Target firewall group. See /v1/firewall/group_list.
direction string Direction of firewall rules. Possible values: "in".
ip_type string IP address type. Possible values: "v4", "v6".

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/iso/create_from_url --data 'url=http://example.com/path/to/CentOS-6.5-x86_64-minimal.iso'

Example Response:

{
"ISOID": 24
}

Parameters:

url string Remote URL from where the ISO will be downloaded.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/iso/list

Example Response:

{
"24": {
"ISOID": 24,
"date_created": "2014-04-01 14:10:09",
"filename": "CentOS-6.5-x86_64-minimal.iso",
"size": 9342976,
"md5sum": "ec0669895a250f803e1709d0402fc411",
"status": "complete"
}
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/iso/list_public

Example Response:

{
"204515": {
"ISOID": 204515,
"name": "CentOS 7",
"description": "7 x86_64 Minimal"
}
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/network/create --data 'DCID=1' --data 'description=test' --data 'v4_subnet=10.99.0.0' --data 'v4_subnet_mask=24'

Example Response:

{ "NETWORKID": "net59a0526477dd3" }

Parameters:

DCID integer Location for the network. See v1/regions/list.
description string (optional) Description of network.
v4_subnet string (optional) IPv4 network to be used when attaching servers to this network.
v4_subnet_mask int (optional) Network mask corresponding with the v4_subnet.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/network/destroy --data 'NETWORKID=net539626f0798d7'

Example Response:

No response, check HTTP result code.

Parameters:

NETWORKID string Unique identifier for this network.  These can be found using the v1/network/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/network/list

Example Response:

{
"net539626f0798d7": {
"DCID": "1",
"NETWORKID": "net539626f0798d7",
"date_created": "2017-08-25 12:23:45",
"description": "test1",
"v4_subnet": "10.99.0.0",
"v4_subnet_mask": 24
},
"net53962b0f2341f": {
"DCID": "1",
"NETWORKID": "net53962b0f2341f",
"date_created": "2014-06-09 17:45:51",
"description": "vultr",
"v4_subnet": "0.0.0.0",
"v4_subnet_mask": 0
}
}

Parameters:

No parameters.

Example Request:

curl https://api.vultr.com/v1/os/list

Example Response:

{
"127": {
"OSID": "127",
"name": "CentOS 6 x64",
"arch": "x64",
"family": "centos",
"windows": false
},
"148": {
"OSID": "148",
"name": "Ubuntu 12.04 i386",
"arch": "i386",
"family": "ubuntu",
"windows": false
}
}

Parameters:

No parameters.

Example Request:

curl https://api.vultr.com/v1/plans/list?type=vc2

Example Response:

{
"1": {
"VPSPLANID": "1",
"name": "Starter",
"vcpu_count": "1",
"ram": "512",
"disk": "20",
"bandwidth": "1",
"price_per_month": "5.00",
"windows": false,
"plan_type": "SSD",
"available_locations": [
1,
2,
3
]
},
"2": {
"VPSPLANID": "2",
"name": "Basic",
"vcpu_count": "1",
"ram": "1024",
"disk": "30",
"bandwidth": "2",
"price_per_month": "8.00",
"windows": false,
"plan_type": "SATA",
"available_locations": [ ],
"deprecated": true
}
}

Parameters:

type string (optional) The type of plans to return. Possible values: "all", "vc2", "ssd", "vdc2", "dedicated".

Example Request:

curl https://api.vultr.com/v1/plans/list_baremetal

Example Response:

{
"1": {
"METALPLANID": "1",
"name": "65536 MB RAM,2x 240 GB SSD,5.00 TB BW",
"cpu_count": 1,
"ram": 65536,
"disk": "2x 240 GB SSD",
"bandwidth_tb": 5,
"price_per_month": 100.00,
"plan_type": "SSD",
"deprecated": false,
"available_locations": [1, 2, 3]
}
}

Parameters:

No parameters.

Example Request:

curl https://api.vultr.com/v1/plans/list_vc2

Example Response:

{
"1": {
"VPSPLANID": "1",
"name": "Starter",
"vcpu_count": "1",
"ram": "512",
"disk": "20",
"bandwidth": "1",
"price_per_month": "5.00",
"plan_type": "SSD"
}
}

Parameters:

No parameters.

Example Request:

curl https://api.vultr.com/v1/plans/list_vdc2

Example Response:

{
"115": {
"VPSPLANID": "115",
"name": "8192 MB RAM,110 GB SSD,10.00 TB BW",
"vcpu_count": "2",
"ram": "8192",
"disk": "110",
"bandwidth": "10.00",
"price_per_month": "60.00",
"plan_type": "DEDICATED"
}
}

Parameters:

No parameters.

Example Request:

curl https://api.vultr.com/v1/regions/availability?DCID=1

Example Response:

[40,11,45,29,41,61]

Parameters:

DCID integer Location to check availability.
type string (optional) The type of plans for which to include availability. Possible values: "all", "vc2", "ssd", "vdc2", "dedicated".

Example Request:

curl https://api.vultr.com/v1/regions/availability_baremetal?DCID=1

Example Response:

[1,2,3,4,5]

Parameters:

DCID integer Location to check availability.

Example Request:

curl https://api.vultr.com/v1/regions/availability_vc2?DCID=1

Example Response:

[40,11,45,29,41,61]

Parameters:

DCID integer Location to check availability.

Example Request:

curl https://api.vultr.com/v1/regions/availability_vdc2?DCID=1

Example Response:

[40,11,45,29,41,61]

Parameters:

DCID integer Location to check availability.

Example Request:

curl https://api.vultr.com/v1/regions/list

Example Response:

{
"1": {
"DCID": "1",
"name": "New Jersey",
"country": "US",
"continent": "North America",
"state": "NJ",
"ddos_protection": true,
"block_storage": true,
"regioncode": "EWR"
},
"2": {
"DCID": "2",
"name": "Chicago",
"country": "US",
"continent": "North America",
"state": "IL",
"ddos_protection": false,
"block_storage": false,
"regioncode": "ORD"
}
}

Parameters:

availability string (optional) 'yes' or 'no'. If 'yes', include the current availability with each region entry.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/attach --data 'ip_address=123.123.123.124/32' --data 'attach_SUBID=5342543'
curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/attach --data 'ip_address=2001:db8:8000::/64' --data 'attach_SUBID=5342543'

Example Response:

No response, check HTTP result code.

Parameters:

ip_address string Reserved IP to be attached. Include the subnet size in this parameter (e.g: /32 or /64).
attach_SUBID integer Unique identifier of the target server.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/convert --data 'SUBID=5342543' --data 'ip_address=2001:db8:8000:/64'

Example Response:

{
"SUBID": 365352
}

Parameters:

SUBID integer SUBID of the server that currently has the IP address you want to convert
ip_address string IP address you want to convert (v4 must be a /32, v6 must be a /64)
label string (optional) Label for this reserved IP

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/create --data 'DCID=1' --data 'ip_type=v4'

Example Response:

{
"SUBID": 1312965
}

Parameters:

DCID integer Location to create this reserved IP in.  See v1/regions/list
ip_type string 'v4' or 'v6' Type of reserved IP to create
label string (optional) Label for this reserved IP

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/destroy --data 'ip_address=2001:db8:8000::/64'

Example Response:

No response, check HTTP result code.

Parameters:

ip_address string Reserved IP to remove from your account.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/detach --data 'ip_address=123.123.123.124/32' --data 'detach_SUBID=5342543'
curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/detach --data 'ip_address=2001:db8:8000::/64' --data 'detach_SUBID=5342543'

Example Response:

No response, check HTTP result code.

Parameters:

ip_address string Reserved IP to be detached. Include the subnet size in this parameter (e.g: /32 or /64).
detach_SUBID integer Unique identifier of the target server.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/reservedip/list

Example Response:

{
"1313044": {
"SUBID": 1313044,
"DCID": 1,
"ip_type": "v4",
"subnet": "10.234.22.53",
"subnet_size": 32,
"label": "my first reserved ip",
"attached_SUBID": 123456
},
"1313045": {
"SUBID": 1313045,
"DCID": 1,
"ip_type": "v6",
"subnet": "2001:db8:9999::",
"subnet_size": 64,
"label": "",
"attached_SUBID": false
}
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/app_change --data 'SUBID=596965' --data 'APPID=2'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
APPID integer Application to use. See /v1/server/app_change_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/app_change_list?SUBID=576965

Example Response:

{
"1": {
"APPID": "1",
"name": "LEMP",
"short_name": "lemp",
"deploy_name": "LEMP on CentOS 6 x64",
"surcharge": 0.00
},
"2": {
"APPID": "2",
"name": "WordPress",
"short_name": "wordpress",
"deploy_name": "WordPress on CentOS 6 x64",
"surcharge": 0.00
}
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/backup_disable --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/backup_enable --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/backup_get_schedule --data 'SUBID=576965'

Example Response:

{
"enabled": true,
"cron_type": "weekly",
"next_scheduled_time_utc": "2016-05-07 08:00:00",
"hour": 8,
"dow": 6,
"dom": 0
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/backup_set_schedule --data 'SUBID=576965' --data 'cron_type=weekly' --data 'hour=8' --data 'dow=6'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
cron_type string Backup cron type. Can be one of 'daily', 'weekly', 'monthly', 'daily_alt_even', or 'daily_alt_odd'.
hour integer (optional) Hour value (0-23). Applicable to crons: 'daily', 'weekly', 'monthly', 'daily_alt_even', 'daily_alt_odd'
dow integer (optional) Day-of-week value (0-6). Applicable to crons: 'weekly'.
dom integer (optional) Day-of-month value (1-28). Applicable to crons: 'monthly'.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/bandwidth?SUBID=576965

Example Response:

{
"incoming_bytes": [
[ "2014-06-10", "81072581" ],
[ "2014-06-11", "222387466" ],
[ "2014-06-12", "216885232" ],
[ "2014-06-13", "117262318" ]
],
"outgoing_bytes": [
[ "2014-06-10", "4059610" ],
[ "2014-06-11", "13432380" ],
[ "2014-06-12", "2455005" ],
[ "2014-06-13", "1106963" ]
]
}

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/create --data 'DCID=1' --data 'VPSPLANID=1' --data 'OSID=127'

Example Response:

{
"SUBID": "1312965"
}

Parameters:

DCID integer Location to create this virtual machine in.  See v1/regions/list
VPSPLANID integer Plan to use when creating this virtual machine.  See v1/plans/list
OSID integer Operating system to use.  See v1/os/list
ipxe_chain_url string (optional) If you've selected the 'custom' operating system, this can be set to chainload the specified URL on bootup, via iPXE
ISOID string (optional)  If you've selected the 'custom' operating system, this is the ID of a specific ISO to mount during the deployment
SCRIPTID integer (optional) If you've not selected a 'custom' operating system, this can be the SCRIPTID of a startup script to execute on boot.  See v1/startupscript/list
SNAPSHOTID string (optional) If you've selected the 'snapshot' operating system, this should be the SNAPSHOTID (see v1/snapshot/list) to restore for the initial installation.
enable_ipv6 string (optional) 'yes' or 'no'.  If yes, an IPv6 subnet will be assigned to the machine (where available)
enable_private_network string (optional) 'yes' or 'no'. If yes, private networking support will be added to the new server.
NETWORKID array (optional) List of private networks to attach to this server.  Use either this field or enable_private_network, not both
label string (optional) This is a text label that will be shown in the control panel
SSHKEYID string (optional) List of SSH keys to apply to this server on install (only valid for Linux/FreeBSD).  See v1/sshkey/list.  Separate keys with commas
auto_backups string (optional) 'yes' or 'no'.  If yes, automatic backups will be enabled for this server (these have an extra charge associated with them)
APPID integer (optional) If launching an application (OSID 186), this is the APPID to launch. See v1/app/list.
userdata string (optional) Base64 encoded user-data
notify_activate string (optional, default 'yes') 'yes' or 'no'. If yes, an activation email will be sent when the server is ready.
ddos_protection (optional, default 'no') 'yes' or 'no'.  If yes, DDOS protection will be enabled on the subscription (there is an additional charge for this)
reserved_ip_v4 string (optional) IP address of the floating IP to use as the main IP of this server
hostname string (optional) The hostname to assign to this server.
tag string (optional) The tag to assign to this server.
FIREWALLGROUPID string (optional) The firewall group to assign to this server. See /v1/firewall/group_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/create_ipv4 --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
reboot string (optional, default 'yes') 'yes' or 'no'. If yes, the server is rebooted immediately.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/destroy --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/destroy_ipv4 --data 'SUBID=576965' --data 'ip=192.0.2.1'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
ip string IPv4 address to remove.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/firewall_group_set --data 'SUBID=576965' --data 'FIREWALLGROUPID=1234abcd'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. See v1/server/list.
FIREWALLGROUPID string The firewall group to apply to this server. A value of "0" means "no firewall group". See /v1/firewall/group_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/get_app_info?SUBID=12345

Example Response:

{
"app_info": ""
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/get_user_data?SUBID=12345

Example Response:

{
"userdata": "ZWNobyBIZWxsbyBXb3JsZA=="
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/halt --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/ipv6_enable --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/iso_attach --data 'SUBID=576965' --data 'ISOID=24'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the /v1/server/list call.
ISOID integer The ISO that will be mounted. See the /v1/iso/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/iso_detach --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the /v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/iso_status --data 'SUBID=576965'

Example Response:

{
"state": "ready",
"ISOID": "0"
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the /v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/label_set --data 'SUBID=576965' --data 'label=example'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
label string This is a text label that will be shown in the control panel.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/list

Example Response:

{
"576965": {
"SUBID": "576965",
"os": "CentOS 6 x64",
"ram": "4096 MB",
"disk": "Virtual 60 GB",
"main_ip": "123.123.123.123",
"vcpu_count": "2",
"location": "New Jersey",
"DCID": "1",
"default_password": "nreqnusibni",
"date_created": "2013-12-19 14:45:41",
"pending_charges": "46.67",
"status": "active",
"cost_per_month": "10.05",
"current_bandwidth_gb": 131.512,
"allowed_bandwidth_gb": "1000",
"netmask_v4": "255.255.255.248",
"gateway_v4": "123.123.123.1",
"power_status": "running",
"server_state": "ok",
"VPSPLANID": "28",
"v6_main_ip": "2001:DB8:1000::100",
"v6_network_size": "64",
"v6_network": "2001:DB8:1000::",
"v6_networks": [{
"v6_network": "2001:DB8:1000::",
"v6_main_ip": "2001:DB8:1000::100",
"v6_network_size": "64"
}],
"label": "my new server",
"internal_ip": "10.99.0.10",
"kvm_url": "https:\/\/my.vultr.com\/subs\/novnc\/api.php?data=eawxFVZw2mXnhGUV",
"auto_backups": "yes",
"tag": "mytag",
"OSID": "127",
"APPID": "0",
"FIREWALLGROUPID": "0"
}
}

Parameters:

SUBID integer (optional) Unique identifier of a subscription. Only the subscription object will be returned.
tag string (optional) A tag string. Only subscription objects with this tag will be returned.
label string (optional) A text label string. Only subscription objects with this text label will be returned.
main_ip string (optional) An IPv4 address. Only the subscription matching this IPv4 address will be returned.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/list_ipv4?SUBID=576965

Example Response:

{
"576965": [
{
"ip": "123.123.123.123",
"netmask": "255.255.255.248",
"gateway": "123.123.123.1",
"type": "main_ip",
"reverse": "host1.example.com"
},
{
"ip": "123.123.123.124",
"netmask": "255.255.255.255",
"gateway": "",
"type": "secondary_ip",
"reverse": "host2.example.com"
},
{
"ip": "10.99.0.10",
"netmask": "255.255.0.0",
"gateway": "",
"type": "private",
"reverse": ""
}
]
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/list_ipv6?SUBID=576965

Example Response:

{
"576965": [
{
"ip": "2001:DB8:1000::100",
"network": "2001:DB8:1000::",
"network_size": "64",
"type": "main_ip"
}
]
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/neighbors?SUBID=12345

Example Response:

[
23456
]

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/os_change --data 'SUBID=576965' --data 'OSID=127'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
OSID integer Operating system to use. See /v1/server/os_change_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/os_change_list?SUBID=576965

Example Response:

{
"127": {
"OSID": "127",
"name": "CentOS 6 x64",
"arch": "x64",
"family": "centos",
"windows": false,
"surcharge": "0.00"
},
"148": {
"OSID": "148",
"name": "Ubuntu 12.04 i386",
"arch": "i386",
"family": "ubuntu",
"windows": false,
"surcharge": "0.00"
}
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/private_network_disable --data 'SUBID=576965' --data 'NETWORKID=net539626f0798d7'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
NETWORKID string Unique identifier for the private network to remove from this subscription. This field is optional if there is only one private network in a given location. See the v1/network/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/private_network_enable --data 'SUBID=576965' --data 'NETWORKID=net539626f0798d7'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
NETWORKID string Unique identifier for the private network to attach to this subscription.  This field is optional if there is only one private network in a given location.  See the v1/network/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/private_networks?SUBID=12345

Example Response:

{
"net539626f0798d7": {
"NETWORKID": "net539626f0798d7",
"mac_address": "5a02.0000.24e9",
"ip_address": "10.99.0.3"
},
"net53962b0f2341f": {
"NETWORKID": "net53962b0f2341f",
"mac_address": "5a01.0000.24e9",
"ip_address": "0.0.0.0"
}
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reboot --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reinstall --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.
hostname string (optional) The hostname to assign to this server.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/restore_backup --data 'SUBID=576965' --data 'BACKUPID=543d34149403a'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.
BACKUPID string BACKUPID (see v1/backup/list) to restore to this instance

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/restore_snapshot --data 'SUBID=576965' --data 'SNAPSHOTID=5359435d28b9a'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.
SNAPSHOTID string SNAPSHOTID (see v1/snapshot/list) to restore to this instance

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reverse_default_ipv4 --data 'SUBID=576965' --data 'ip=192.0.2.1'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
ip string IPv4 address used in the reverse DNS update. These can be found with the v1/server/list_ipv4 call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reverse_delete_ipv6 --data 'SUBID=576965' --data 'ip=2001:db8:1234::'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
ip string IPv6 address used in the reverse DNS update. These can be found with the v1/server/reverse_list_ipv6 call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reverse_list_ipv6?SUBID=576965

Example Response:

{
"576965": [
{
"ip": "2001:DB8:1000::101",
"reverse": "host1.example.com"
},
{
"ip": "2001:DB8:1000::102",
"reverse": "host2.example.com"
}
]
}

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reverse_set_ipv4 --data 'SUBID=576965' --data 'ip=192.0.2.1' --data 'entry=example.vultr.com'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
ip string IPv4 address used in the reverse DNS update. These can be found with the v1/server/list_ipv4 call.
entry string reverse DNS entry.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/reverse_set_ipv6 --data 'SUBID=576965' --data 'ip=2001:db8:1234::' --data 'entry=example.vultr.com'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
ip string IPv6 address used in the reverse DNS update. These can be found with the v1/server/list_ipv6 or v1/server/reverse_list_ipv6 calls.
entry string reverse DNS entry.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/set_user_data --data 'SUBID=12345' --data 'userdata=ZWNobyBIZWxsbyBXb3JsZA==''

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
userdata string Base64 encoded user-data

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/start --data 'SUBID=576965'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription.  These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/tag_set --data 'SUBID=576965' --data 'tag=Mail'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
tag string The tag to assign to this server. This tag is shown in the control panel.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/upgrade_plan --data 'SUBID=576965' --data 'VPSPLANID=29'

Example Response:

No response, check HTTP result code.

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.
VPSPLANID integer The new plan. See /v1/server/upgrade_plan_list.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/server/upgrade_plan_list?SUBID=576965

Example Response:

[29,41,61]

Parameters:

SUBID integer Unique identifier for this subscription. These can be found using the v1/server/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/snapshot/create --data 'SUBID=1312965'

Example Response:

{ "SNAPSHOTID": "544e52f31c706" }

Parameters:

SUBID integer Identifier of the virtual machine to create a snapshot from.  See v1/server/list
description string (optional) Description of snapshot contents

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/snapshot/create_from_url --data 'url=http://example.com/path/to/disk_image.raw'

Example Response:

{ "SNAPSHOTID": "544e52f31c706" }

Parameters:

url string Remote URL from where the snapshot will be downloaded.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/snapshot/destroy --data 'SNAPSHOTID=5359435d28b9a'

Example Response:

No response, check HTTP result code.

Parameters:

SNAPSHOTID string Unique identifier for this snapshot.  These can be found using the v1/snapshot/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/snapshot/list

Example Response:

{
"5359435d28b9a": {
"SNAPSHOTID": "5359435d28b9a",
"date_created": "2014-04-18 12:40:40",
"description": "Test snapshot",
"size": "42949672960",
"status": "complete",
"OSID": "127",
"APPID": "0"
},
"5359435dc1df3": {
"SNAPSHOTID": "5359435dc1df3",
"date_created": "2014-04-22 16:11:46",
"description": "",
"size": "10000000",
"status": "complete",
"OSID": "127",
"APPID": "0"
}
}

Parameters:

SNAPSHOTID string (optional) Filter result set to only contain this snapshot.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/sshkey/create --data 'name=test SSH KEY' --data 'ssh_key=ssh-rsa AA... test@example.com'

Example Response:

{ "SSHKEYID": "541b4960f23bd" }

Parameters:

name string Name of the SSH key
ssh_key string SSH public key (in authorized_keys format)

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/sshkey/destroy --data 'SSHKEYID=541b4960f23bd'

Example Response:

No response, check HTTP result code.

Parameters:

SSHKEYID string Unique identifier for this SSH key.  These can be found using the v1/sshkey/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/sshkey/list

Example Response:

{
"541b4960f23bd": {
"SSHKEYID": "541b4960f23bd",
"date_created": null,
"name": "test",
"ssh_key": "ssh-rsa AA... test@example.com"
}
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/sshkey/update --data 'SSHKEYID=541b4960f23bd' --data 'name=new key name' --data 'ssh_key=ssh-rsa AA... someother@example.com'

Example Response:

No response, check HTTP result code.

Parameters:

SSHKEYID string SSHKEYID of key to update (see /v1/sshkey/list)
name string (optional) New name for the SSH key
ssh_key string (optional) New SSH key contents

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/startupscript/create --data 'name=my first script' --data $'script=#!/bin/bash\necho hello world > /root/hello'

Example Response:

{ "SCRIPTID": 5 }

Parameters:

name string Name of the newly created startup script.
script string Startup script contents.
type string boot|pxe (optional) Type of startup script. Default is 'boot'.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/startupscript/destroy --data 'SCRIPTID=5'

Example Response:

No response, check HTTP result code.

Parameters:

SCRIPTID string Unique identifier for this startup script. These can be found using the v1/startupscript/list call.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/startupscript/list

Example Response:

{
"3": {
"SCRIPTID": "3",
"date_created": "2014-05-21 15:27:18",
"date_modified": "2014-05-21 15:27:18",
"name": "test ",
"type": "boot",
"script": "#!/bin/bash echo Hello World > /root/hello"
},
"5": {
"SCRIPTID": "5",
"date_created": "2014-08-22 15:27:18",
"date_modified": "2014-09-22 15:27:18",
"name": "test ",
"type": "pxe",
"script": "#!ipxe\necho Hello World\nshell"
}
}

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/startupscript/update --data 'SCRIPTID=5' --data 'name=my first script' --data 'script=#!/bin/bash\necho hello world > /root/hello'

Example Response:

No response, check HTTP result code.

Parameters:

SCRIPTID integer SCRIPTID of script to update (see /v1/startupscript/list).
name string (optional) New name for the startup script.
script string (optional) New startup script contents.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/user/create --data 'email=new@vultr.com' --data 'name=test user' --data 'password=badpassword' --data 'acls[]=manage_users' --data 'acls[]=subscriptions'

Example Response:

{
"USERID": "564a1a88947b4",
"api_key":"AAAAAAAA"
}

Parameters:

email string Email address for this user
name string Name for this user
password Password for this user
api_enabled string (optional) 'yes' or 'no'. If yes, this user's API key will work on api.vultr.com.  Default is yes
acls array List of ACLs that this user should have.  See /v1/user/list for information on possible ACLs

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/user/delete --data 'USERID=564a1a88947b4'

Example Response:

No response, check HTTP result code.

Parameters:

USERID int ID of the user to delete

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/user/list

Example Response:

[
{
"USERID": "564a1a7794d83",
"name": "example user 1",
"email": "example@vultr.com",
"api_enabled": "yes",
"acls": [
"manage_users",
"subscriptions",
"billing",
"provisioning"
]
},
{
"USERID": "564a1a88947b4",
"name": "example user 2",
"email": "example@vultr.com",
"api_enabled": "no",
"acls": [
"support",
"dns"
]
}
]

Parameters:

No parameters.

Example Request:

curl -H 'API-Key: YOURKEY' https://api.vultr.com/v1/user/update --data 'USERID=564a1a88947b4' --data 'email=new@vultr.com' --data 'password=badpassword' --data 'acls[]=manage_users' --data 'acls[]=subscriptions'

Example Response:

No response, check HTTP result code.

Parameters:

USERID string ID of the user to update
email string (optional) New email address for this user
name string (optional) New name for this user
password string (optional) New password for this user
api_enabled string (optional) 'yes' or 'no'. If yes, this user's API key will work on api.vultr.com
acls array (optional) List of ACLs that this user should have.  See /v1/user/list for information on possible ACLs