Vultr DocsLatest Docs

Vultr API v1 to v2 Transition Strategies

Vultr APIMeta PaginationAPI Transition
Updated on July 4, 2023
Vultr API v1 to v2 Transition Strategies header image

Vultr deprecated API v1 when API v2 was announced as GA in 2021. Please note that the v1 endpoint will cease to function on August 14th 2023. To avoid service disruption with the API interface, please migrate your systems to API v2 as soon as possible.

Documentation for API v2 can be found at https://www.vultr.com/api/.

Upgrade Strategies:

  • If you are using one of our SDKs or CLI tools from the Vultr Github, simply update to the latest version.
  • If you are using a commercial or open source third party module to automate your orchestration, chances are that they have a new version that supports API v2. Contact the module publisher to check.
  • APIv1 returns the field v2_id for resources to simplify the transition process to APIv2.

Notable Changes:

  • Resource IDs are no longer numeric - they are now in uuid format. The old identifier was an integer value and the new identifiers are in string formats. New identifier example: cb676a46-66fd-4dfb-b839-443f2e6c0b60.
  • APIv2 utilizes paging concepts for results that are too long to display in one page. You can see how this works here: https://www.vultr.com/api/#section/Introduction/Meta-and-Pagination

Vultr API Timeline:

  • June 2020 - API v2 was introduced.
  • July 2021 - API v2 was declared ready for production usage.
  • February 2023 - API v1 EoL announced for June 30, 2023.
  • August 2023 - API v1 will cease to function.