How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vultr Instances API

Vultr [Cloud instances](https://www.vultr.com/products/cloud-compute/) can be [deployed](https://my.vultr.com/) with your preferred operating system or pre-installed application in seconds. [High Frequency Compute](https://www.vultr.com/products/high-frequency-compute/) instances are powered by high clock speed CPU's and NVMe local storage to power your most demanding applications. [Dedicated Cloud](https://www.vultr.com/products/dedicated-cloud/) instances have dedicated CPU, SSD drives, and RAM.

Vultr Instances API is one of 46 APIs that Vultr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Instances. The published artifact set on APIs.io includes an OpenAPI specification and 12 JSON Schemas.

This API exposes 40 operations across 34 paths, and defines 78 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://api.vultr.com/v2.

40 operations 34 paths 78 schemas 3 DELETE14 GET1 PATCH22 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.vultr.com/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Vultr Instances API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (API_Key). It accepts HTTP bearer tokens (API Key). By default, every request must be authenticated.

  • API_Key — The Vultr API v2 uses API keys for authentication. You can manage your API keys in the Vultr customer portal. Please do not share API keys publicly, or embed t…
  • API Key — The Vultr API v2 uses API keys for authentication. You can manage your API keys in the Vultr customer portal. Please do not share API keys publicly, or embed t…

Paths & Operations 40

Across 34 paths, the API surfaces 40 operations — 3 DELETE, 14 GET, 1 PATCH, 22 POST. Each is listed below with its method, path, parameters, and response codes.

Instances 40

Vultr Cloud instances can be deployed with your preferred operating system or pre-installed application in seconds. High Frequency Compute instances are powered by high clock spee…

GET
/instances
List Instances
list-instances 5 params → 200400401403404
POST
/instances
Create Instance
create-instance body → 202400401403404
GET
/instances/{instance-id}
Get Instance
get-instance 1 param → 200400401403404
PATCH
/instances/{instance-id}
Update Instance
update-instance 1 param body → 202400401404
DELETE
/instances/{instance-id}
Delete Instance
delete-instance 1 param → 204400401404
POST
/instances/halt
Halt Instances
halt-instances body → 204400401404
POST
/instances/reboot
Reboot instances
reboot-instances body → 204400401404
POST
/instances/start
Start instances
start-instances body → 204400401404
POST
/instances/{instance-id}/start
Start instance
start-instance 1 param → 204400401404
POST
/instances/{instance-id}/reboot
Reboot Instance
reboot-instance 1 param → 204400401404
POST
/instances/{instance-id}/reinstall
Reinstall Instance
reinstall-instance 1 param body → 202400401404
GET
/instances/{instance-id}/bandwidth
Instance Bandwidth
get-instance-bandwidth 1 param → 200400401404
GET
/instances/{instance-id}/neighbors
Get Instance neighbors
get-instance-neighbors 1 param → 200400401404
GET
/instances/{instance-id}/private-networks
List instance Private Networks
list-instance-private-networks 3 params → 200400401404
GET
/instances/{instance-id}/iso
Get Instance ISO Status
get-instance-iso-status 1 param → 200400401404
POST
/instances/{instance-id}/iso/attach
Attach ISO to Instance
attach-instance-iso 1 param body → 202400401404
POST
/instances/{instance-id}/iso/detach
Detach ISO from instance
detach-instance-iso 1 param → 202400401404
POST
/instances/{instance-id}/private-networks/attach
Attach Private Network to Instance
attach-instance-network 1 param body → 204400401404
POST
/instances/{instance-id}/private-networks/detach
Detach Private Network from Instance
detach-instance-network 1 param body → 204400401404
POST
/instances/{instance-id}/backup-schedule
Set Instance Backup Schedule
create-instance-backup-schedule 1 param body → 200401404
GET
/instances/{instance-id}/backup-schedule
Get Instance Backup Schedule
get-instance-backup-schedule 1 param → 200400401404
POST
/instances/{instance-id}/restore
Restore Instance
restore-instance 1 param body → 202400401404
GET
/instances/{instance-id}/ipv4
List Instance IPv4 Information
get-instance-ipv4 4 params → 200400401404
POST
/instances/{instance-id}/ipv4
Create IPv4
create-instance-ipv4 1 param body → 202400401404
GET
/instances/{instance-id}/ipv6
Get Instance IPv6 Information
get-instance-ipv6 1 param → 200400401404
POST
/instances/{instance-id}/ipv6/reverse
Create Instance Reverse IPv6
create-instance-reverse-ipv6 1 param body → 204400401404
GET
/instances/{instance-id}/ipv6/reverse
List Instance IPv6 Reverse
list-instance-ipv6-reverse 1 param → 200
POST
/instances/{instance-id}/ipv4/reverse
Create Instance Reverse IPv4
create-instance-reverse-ipv4 1 param body → 204400401404
GET
/instances/{instance-id}/user-data
Get Instance User Data
get-instance-userdata 1 param → 200
POST
/instances/{instance-id}/halt
Halt Instance
halt-instance 1 param → 204400401404
POST
/instances/{instance-id}/ipv4/reverse/default
Set Default Reverse DNS Entry
post-instances-instance-id-ipv4-reverse-default 1 param body → 204400401404
DELETE
/instances/{instance-id}/ipv4/{ipv4}
Delete IPv4 Address
delete-instance-ipv4 2 params → 204400401403
DELETE
/instances/{instance-id}/ipv6/reverse/{ipv6}
Delete Instance Reverse IPv6
delete-instance-reverse-ipv6 2 params → 204400401403
GET
/instances/{instance-id}/upgrades
Get Available Instance Upgrades
get-instance-upgrades 2 params → 200400401403404
GET
/instances/{instance-id}/vpcs
List instance VPCs
list-instance-vpcs 3 params → 200400401404
GET
/instances/{instance-id}/vpc2
List Instance VPC 2.0 Networks
list-instance-vpc2 3 params → 200400401404
POST
/instances/{instance-id}/vpcs/attach
Attach VPC to Instance
attach-instance-vpc 1 param body → 204400401404
POST
/instances/{instance-id}/vpcs/detach
Detach VPC from Instance
detach-instance-vpc 1 param body → 204400401404
POST
/instances/{instance-id}/vpc2/attach
Attach VPC 2.0 Network to Instance
attach-instance-vpc2 1 param body → 202400401404
POST
/instances/{instance-id}/vpc2/detach
Detach VPC 2.0 Network from Instance
detach-instance-vpc2 1 param body → 202400401404

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are create_instance_request (29 properties), instance_2 (29 properties), instance_3 (29 properties), instance (27 properties). Each schema is shown below with its type and property counts.

baremetal-ipv6
object
Bare Metal IPv6 information.
4 properties
meta
object
The meta information object. See [Meta and Pagination](section/Introduction/Meta-and-Pagination) for more information.
2 properties
private-networks
object
Private Network information.
3 properties
instance
object
Instance information.
27 properties
backup-schedule
object
Backup schedule information.
6 properties
baremetal-ipv4
object
Bare Metal IPv4 information.
6 properties
bandwidth
object
Bandwidth information.
2 properties
restore_instance_202_response_status
object
3 properties
list_instance_private_networks_200_response
object
2 properties
create_instance_reverse_ipv4_request
object
2 properties 2 required
list_instance_vpcs_200_response
object
2 properties
detach_instance_iso_202_response_iso_status
object
1 property
attach_instance_vpc_request
object
1 property
instance-vpc2
object
VPC 2.0 information.
3 properties 1 required
instance_2
object
Instance information.
29 properties
get_ipv6_baremetal_200_response
object
2 properties
get_bandwidth_baremetal_200_response
object
1 property
backup-schedule_2
object
Backup schedule information.
6 properties
meta_links
object
Cursor values for pagination.
2 properties
bandwidth_2
object
Bandwidth information.
2 properties
reboot_instances_request
object
1 property
baremetal-ipv6_2
object
Bare Metal IPv6 information.
4 properties
list_instance_ipv6_reverse_200_response_reverse_ipv6s_inner
object
2 properties
reinstall_instance_request
object
1 property
get_instance_userdata_200_response_user_data
object
1 property
detach_instance_vpc_request
object
1 property
create_instance_202_response
object
1 property
post_instances_instance_id_ipv4_reverse_default_request
object
1 property 1 required
create_instance_backup_schedule_request
object
4 properties 1 required
detach_instance_iso_202_response
object
1 property
get_instance_upgrades_200_response
object
1 property
get_ipv4_baremetal_200_response
object
2 properties
baremetal-ipv4_2
object
Bare Metal IPv4 information.
6 properties
get_instance_iso_status_200_response_iso_status
object
2 properties
update_instance_request
object
22 properties
private-networks_2
object
Private Network information.
3 properties
create_instance_ipv4_request
object
1 property
attach_instance_vpc2_request
object
2 properties 1 required
vpc
object
VPC information.
6 properties 1 required
attach_instance_iso_202_response_iso_status
object
2 properties
list_instance_ipv6_reverse_200_response
object
1 property
restore_instance_request
object
2 properties
get_instance_neighbors_200_response
object
1 property
create_instance_reverse_ipv6_request
object
2 properties 2 required
create_instance_request
object
29 properties 2 required
list_instances_200_response
object
2 properties
get_instance_userdata_200_response
object
1 property
restore_instance_202_response
object
1 property
attach_instance_network_request
object
1 property
meta_2
object
The meta information object. See [Meta and Pagination](section/Introduction/Meta-and-Pagination) for more information.
2 properties
attach_instance_iso_request
object
1 property
get_bandwidth_baremetal_200_response_bandwidth
object
This object will contain objects that represent days in the month (UTC). The date is denoted by the nested objects keys.
2 properties
get_instance_upgrades_200_response_upgrades
object
3 properties
halt_instances_request
object
1 property
get_instance_backup_schedule_200_response
object
1 property
detach_instance_network_request
object
1 property
start_instances_request
object
1 property
attach_instance_iso_202_response
object
1 property
list_instance_vpc2_200_response
object
2 properties
instance_v6_networks_inner
object
An IPv6 object.
3 properties
get_instance_iso_status_200_response
object
1 property
detach_instance_vpc2_request
object
1 property 1 required
list_instance_private_networks_200_response_2
object
2 properties
list_instance_vpcs_200_response_2
object
2 properties
instance_3
object
Instance information.
29 properties
get_ipv6_baremetal_200_response_2
object
2 properties
backup-schedule_3
object
Backup schedule information.
6 properties
bandwidth_3
object
Bandwidth information.
2 properties
baremetal-ipv6_3
object
Bare Metal IPv6 information.
4 properties
create_instance_202_response_2
object
1 property
get_ipv4_baremetal_200_response_2
object
2 properties
baremetal-ipv4_3
object
Bare Metal IPv4 information.
6 properties
private-networks_3
object
Private Network information.
3 properties
list_instances_200_response_2
object
2 properties
meta_3
object
The meta information object. See [Meta and Pagination](section/Introduction/Meta-and-Pagination) for more information.
2 properties
get_bandwidth_baremetal_200_response_bandwidth_2
object
This object will contain objects that represent days in the month (UTC). The date is denoted by the nested objects keys.
2 properties
get_instance_backup_schedule_200_response_2
object
1 property
list_instance_vpc2_200_response_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vultr-instances-api-openapi.yml Raw ↑

Other APIs Vultr publishes across the network.

Vultr Account API
Vultr Application API
Vultr Backup API
Vultr Baremetal API
Vultr Billing API
Vultr Block API
Vultr Container Registry API
Vultr Dns API
Vultr Firewall API
Vultr IAM Assumed Roles API
Vultr IAM Endpoint Actions API
Vultr IAM Groups API
Where this information came from

This is an independent, third-party profile of Vultr Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.