API Reference
DocsContact supportSign in
Start typing to search…

API Changelog

June 1st, 2023

  • New API version: v2023-06-01
  • Resource IDs are now hashed in the following format: <RESOURCE_PREFIX>_<HASHED_ID>. IDs are fully backwards compatible with older API versions. We recommend moving to the new ID format for consistency, but you can continue using sequential IDs.
  • Breaking Change: GET /servers
    • Added regions field
    • Changed features field
    • Deprecated line, name, and available_in fields
  • Breaking Change: GET /plans
    • Removed the propertiesname, line, available_in
    • features is now an array that can include ssh, raid or user_data.
    • cpus has been renamed cpu
    • cpu and gpu are now an object and no longer an array.
    • available_in has been replaced by regions
  • GET /ips
    • Removed the role property
  • Breaking Change: GET /traffic
    • Changed filter[from_date] and filter[to_date] are now using ISO date format
    • Renamed to GET /traffic/usage
  • GET /project/<project_id>
    • Added same details of each project from GET /projects
  • Breaking Change: GET /regions
    • Renamed to GET /locations
  • Breaking Change: PUT /projects/<project_id>/ssh_keys/<ssh_key_id>
    • Changed method PUT to PATCH
  • PATCH /team
    • Added referred_code and currency fields.
  • GET /project/<project_id>/user_data
    • Added decoded_contentas a default property
    • Removed projectand user
  • Breaking Change: GET /virtual_networks
    • Changed filter[site] to filter[location]
    • Changed site to location
  • Breaking Change: POST /virtual_networks
    • Changed site to location

December 27, 2022

  • GET /servers - Added sorting by created_at and new filters: operating_system, status, label, created_at_gte, and created_at_lte.
  • GET /plans - Added new filters: location, in_stock, and stock_level.
  • Removed header application/vnd.maxihost.v2+json from the docs.

December 20, 2022

  • GET /ips - Added new filters: family, type, location, and address.
  • Deprecated the include parameter for all resources. Objects that previously needed to be included now return by default in their respective payloads.

December 14, 2022

  • GET /plans - Added new field instant to identify in which location and SO we have instant deployment (~60 seconds)

December 6, 2022

  • Updated multiple API sections to make it easier to navigate the documentation.

November 24, 2022

  • POST servers/{id}/remote_access - Fixed multiple remote access connections into a single VPN session

October 31, 2022

  • Removed support for filtering locations by Core and Custom field type from /regions