VPS

List addons you can add to a server

get/vps/{vps_id}/available-addons

See the extras you can add to this server, such as the 10 Gbps port, with their price per month and per hour. If something stops you from adding them right now (for example the server is busy or your organization is too new), the reason comes with the list, and so does which addons of the server you can remove yourself.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Path parameters

vps_id*integer

Range1 ≤ value

Responses

Successful Response

application/json

addons*array<AvailableAddonOut>

Addons offered for this server's plan and location that it does not have yet.

Properties (17)

slug*string

name*string

description?string | null

category*string

charge_type*string

pricing_model*string

unit_label?string | null

min_quantity*integer

max_quantity*integer

quantity_step*integer

monthly_price*number

hourly_price?number | null

setup_fee*number

currency?string

Default"USD"

exclusive_group?string | null

min_term_months?integer

Default0

sort_order?integer

Default0

blocked?VPSAddonBlockedOut | null

The first thing that would stop the addition right now, or null when you can add them.

Properties (2)

code*string

Short reason: hourly_only, server_state_not_allowed, no_public_nic, not_eligible_new_organization, not_eligible_no_payment, service_not_live, organization_suspended, suspended (the server), managed_by_kubernetes, server_not_available, rescue_transition, too_many_changes (3 adds in 24 hours), insufficient_balance, email_not_confirmed, organization_not_verified or terms_acceptance_required.

detail*string

The reason in your language.

removable_addons?array<string>

Contract uuids of the addons on this server that you can remove yourself right now with DELETE /vps/{vps_id}/addons/{contract_uuid}. Empty when the server or organization is suspended.