> ## Documentation Index > Fetch the complete documentation index at: https://docs.advinservers.com/llms.txt > Use this file to discover all available pages before exploring further. # List upgrade plans for a server > ### Overview Lists available upgrade plans, grouped by product and location. `current_group_id` and `current_location_id` identify the current plan's group and location. `current_disk` is the current disk size. `disk_resize_required` indicates whether the disk must grow, and `migration_allowed` indicates whether the server can move to another location. `has_attached_floating_ips` indicates that a floating IP is attached; plans in another location are still listed, but quoting one is refused until the floating IPs are detached. A plan listed as available can still be quoted for ten minutes after the catalogue was read, even if the capacity it was listed on is taken in the meantime. `location_change_fee` and `product_change_fee` are the fixed fees for changing location or product group. Use these to show fees before requesting a quote. When upgrades are unavailable, `enabled` is false and no plans are returned. ### Permissions Requires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404. ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json get /servers/{server}/upgrades/catalog openapi: 3.1.0 info: title: API reference version: 1.0.0 description: >- Use this API to manage your team's servers, networks, backups, and other resources. ## Authentication Create an API key under **API Keys** and send it as a bearer token with every request: ``` Authorization: Bearer {YOUR_API_KEY} Accept: application/json ``` Copy the key when you create it. It cannot be shown again. Revoking a key takes effect immediately. ## Permissions Give each key only the permissions it needs. Every endpoint lists the required permission. Permissions cover servers and other resources in the key's team. ## Team scope A key can access resources in the team selected when it was created. This includes servers, snapshots, backups, firewall groups, images, SSH keys, scripts, networks and addresses. Resources in other teams return `404 Not Found`. Create a separate key for each team. The key determines the team for every request. Legacy keys that had no team are assigned to the account's first owned team. ## Actions that need the panel API keys cannot do the following, even with every permission. Sign in to the panel in a browser to do them: - Create, edit or revoke API keys - Edit the IP groups that restrict API keys - End signed-in sessions - Change two-factor authentication - Change the account's email address - Accept or decline team invitations - Switch or leave a team This keeps a leaked key from widening its own access or locking you out of your account. ## Source IP restrictions A key can be restricted to one or more IP groups. Requests from other addresses are rejected. ## Requests and responses Each endpoint lists its path, query, header, and body parameters. Examples use fictional data. Single records use JSON objects. Collections use JSON arrays unless the endpoint supports pagination. Timestamps use ISO 8601 in UTC. Error responses include `message`. Validation errors also include an `errors` object for each field. Each endpoint lists its status codes. ## Audit log Every API request, including reads, is recorded in the account audit log with the key that made it. servers: - url: https://console.advinservers.com/api/v1/client security: - http: [] tags: - name: Account description: Billing contact details and account setup progress. - name: Account activity description: Actions performed in the current team by people and API keys. - name: Servers description: >- Order and list servers, read their state and resource use, open a console, and control power. - name: Server settings description: >- Rename a server, rebuild it, and change its hardware, media, resolvers and credentials. - name: Backups description: Scheduled server copies stored separately from the server. - name: Snapshots description: >- Take, restore and move server snapshots. Snapshots are kept in snapshot storage that the team buys by the GiB. - name: Firewall groups description: Reusable sets of firewall rules, and the servers they apply to. - name: IP groups description: Reusable source address lists for firewall rules. - name: Server firewall description: >- Read default traffic policies and rules managed outside your firewall groups. - name: IP addresses description: Manage floating IPs and server address assignments. - name: Private networks description: Connect servers over a private network in the same location. - name: Reverse DNS description: Set the hostnames returned by IP address lookups. - name: DDoS protection description: Configure attack filtering for server addresses. - name: Bandwidth description: Buy extra bandwidth and share it between servers or location pools. - name: SSH keys description: Public keys the account can install on a server when it is built. - name: Setup scripts description: Scripts the account can run on a server when it is built. - name: ISO images description: ISO images you have downloaded, and the servers they are mounted on. - name: Server upgrades description: Change an existing server's plan. - name: Checkout description: Choose a payment method and pay for a purchase. - name: Invoices description: View and pay account invoices. - name: Billing description: Manage service renewals, payment methods and account credit. - name: Transfers description: Move resources between teams or transfer ownership. - name: Teams description: Manage the team assigned to your API key. - name: Team members description: Invite people and manage their team access. - name: Team roles description: Define the permissions granted to team members. - name: Team activity description: View actions performed in a team. - name: Support tickets description: >- Open, read, reply to and close support tickets. Tickets belong to the account holder and are not shared with team members. paths: /servers/{server}/upgrades/catalog: get: tags: - Server upgrades summary: List upgrade plans for a server description: >- ### Overview Lists available upgrade plans, grouped by product and location. `current_group_id` and `current_location_id` identify the current plan's group and location. `current_disk` is the current disk size. `disk_resize_required` indicates whether the disk must grow, and `migration_allowed` indicates whether the server can move to another location. `has_attached_floating_ips` indicates that a floating IP is attached; plans in another location are still listed, but quoting one is refused until the floating IPs are detached. A plan listed as available can still be quoted for ten minutes after the catalogue was read, even if the capacity it was listed on is taken in the meantime. `location_change_fee` and `product_change_fee` are the fixed fees for changing location or product group. Use these to show fees before requesting a quote. When upgrades are unavailable, `enabled` is false and no plans are returned. ### Permissions Requires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404. operationId: client.servers.upgrades.catalog parameters: - name: server in: path required: true description: The server UUID schema: type: string examples: - ecc6f4f1 example: ecc6f4f1 responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: type: object examples: - enabled: true currency: USD current_location_id: 3 current_group_id: '2' current_disk: 85899345920 disk_resize_required: false migration_allowed: true has_attached_floating_ips: false location_change_fee: '5.00' product_change_fee: '2.50' groups: - id: '2' name: Standard VPS description: >- NVMe storage, DDR5 memory and a 10 Gbps port on every plan. subtext: null speed: 10 Gbps ddr5: true locations: - id: 2-3 display_name: Kansas City, MO name: Kansas City, MO flag_url: null cid: 3 group_name: Standard VPS location_id: 3 product_group_id: 2 plans: - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null is_current: true properties: enabled: type: boolean description: The value of `enabled`. examples: - true currency: type: string description: The three-letter currency code used for monetary amounts. examples: - USD current_location_id: type: integer description: The current location id ID. examples: - 3 current_group_id: type: - string - 'null' description: The current group id ID. examples: - '2' current_disk: type: integer description: Current primary disk capacity in bytes. examples: - 85899345920 disk_resize_required: type: boolean description: The value of `disk_resize_required`. examples: - false migration_allowed: type: boolean description: The value of `migration_allowed`. examples: - true has_attached_floating_ips: type: boolean description: Whether the resource has attached floating ips. examples: - false location_change_fee: type: string description: The value of `location_change_fee`. examples: - '5.00' product_change_fee: type: string description: The value of `product_change_fee`. examples: - '2.50' groups: type: array description: The value of `groups`. examples: - - id: '2' name: Standard VPS description: >- NVMe storage, DDR5 memory and a 10 Gbps port on every plan. subtext: null speed: 10 Gbps ddr5: true locations: - id: 2-3 display_name: Kansas City, MO name: Kansas City, MO flag_url: null cid: 3 group_name: Standard VPS location_id: 3 product_group_id: 2 plans: - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null is_current: true items: type: object examples: - id: '2' name: Standard VPS description: >- NVMe storage, DDR5 memory and a 10 Gbps port on every plan. subtext: null speed: 10 Gbps ddr5: true locations: - id: 2-3 display_name: Kansas City, MO name: Kansas City, MO flag_url: null cid: 3 group_name: Standard VPS location_id: 3 product_group_id: 2 plans: - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null is_current: true properties: id: type: string description: The id ID. examples: - '2' name: type: string description: The name shown to customers. examples: - Standard VPS description: type: - string - 'null' description: An optional description shown to customers. examples: - >- NVMe storage, DDR5 memory and a 10 Gbps port on every plan. subtext: type: - string - 'null' description: The value of `subtext`. examples: - null speed: type: - string - 'null' description: The value of `speed`. examples: - 10 Gbps ddr5: type: boolean description: The value of `ddr5`. examples: - true locations: type: array description: The value of `locations`. examples: - - id: 2-3 display_name: Kansas City, MO name: Kansas City, MO flag_url: null cid: 3 group_name: Standard VPS location_id: 3 product_group_id: 2 plans: - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null is_current: true items: type: object examples: - id: 2-3 display_name: Kansas City, MO name: Kansas City, MO flag_url: null cid: 3 group_name: Standard VPS location_id: 3 product_group_id: 2 plans: - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null is_current: true properties: id: type: string description: The id ID. examples: - 2-3 display_name: type: string description: The value of `display_name`. examples: - Kansas City, MO name: type: string description: The name shown to customers. examples: - Kansas City, MO flag_url: type: - string - 'null' description: The value of `flag_url`. examples: - null cid: type: integer description: The value of `cid`. examples: - 3 group_name: type: string description: The value of `group_name`. examples: - Standard VPS location_id: type: integer description: The location id ID. examples: - 3 product_group_id: type: integer description: The product group id ID. examples: - 2 plans: type: array description: The value of `plans`. examples: - - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null items: type: object examples: - key: >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: standard-8gb name: Standard 8 GB vcpu_cores: 6 memory: 8000 disk: 160 bandwidth: 10000 hdd: false primary_disk: 160 hdd_disk: 0 price: '22.00' deployment_time: Instant whmcs_id: '49' available: true whmcs_url: >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: null available_with_disk_resize: true unavailable_with_disk_resize_reason: null properties: key: type: string description: The value of `key`. examples: - >- 84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc id: type: string description: The id ID. examples: - standard-8gb name: type: string description: The name shown to customers. examples: - Standard 8 GB vcpu_cores: type: integer description: The value of `vcpu_cores`. examples: - 6 memory: type: integer description: >- Memory in advertised units; 1000 represents 1 GiB. examples: - 8000 disk: type: integer description: Advertised disk capacity in GiB. examples: - 160 bandwidth: type: integer description: >- Transfer allowance in advertised units; 1000 represents 1 TiB and zero means unlimited. examples: - 10000 hdd: type: boolean description: The value of `hdd`. examples: - false primary_disk: type: integer description: Primary disk capacity in GiB. examples: - 160 hdd_disk: type: integer description: Secondary hard disk capacity in GiB. examples: - 0 price: type: string description: The value of `price`. examples: - '22.00' deployment_time: type: - string - 'null' description: The value of `deployment_time`. examples: - Instant whmcs_id: type: string description: The billing product identifier. examples: - '49' available: type: boolean description: The value of `available`. examples: - true whmcs_url: type: - string - 'null' description: The external order URL, when configured. examples: - >- https://clients.advinservers.com/cart.php?a=add&pid=49 unavailable_reason: type: - string - 'null' description: The value of `unavailable_reason`. examples: - null available_with_disk_resize: type: boolean description: >- The value of `available_with_disk_resize`. examples: - true unavailable_with_disk_resize_reason: type: - string - 'null' description: >- The value of `unavailable_with_disk_resize_reason`. examples: - null required: - key - id - name - vcpu_cores - memory - disk - bandwidth - hdd - primary_disk - hdd_disk - price - deployment_time - whmcs_id - available - whmcs_url - unavailable_reason - available_with_disk_resize - unavailable_with_disk_resize_reason is_current: type: boolean description: Whether the resource is current. examples: - true required: - id - display_name - name - flag_url - cid - group_name - location_id - product_group_id - plans - is_current required: - id - name - description - subtext - speed - ddr5 - locations required: - enabled - currency - current_location_id - current_group_id - current_disk - disk_resize_required - migration_allowed - has_attached_floating_ips - location_change_fee - product_change_fee - groups '401': description: >- The key was missing, malformed, revoked, or belongs to an account that no longer exists. content: application/json: schema: type: object properties: message: type: string examples: - Unauthenticated. required: - message '403': description: >- Access denied. Check the key's team, permissions and allowed IP addresses. Some actions, such as managing API keys, require a browser session. The response message explains the reason. content: application/json: schema: type: object properties: message: type: string examples: - >- This API key is not allowed to do that in this team. It needs the "snapshot.delete" permission. required: - message '404': description: >- The resource was not found in the selected team. Resources in another account or team also return 404. content: application/json: schema: type: object properties: message: type: string examples: - Not found. required: - message '429': description: >- Too many requests. The `Retry-After` header says how many seconds to wait. Limits are per account, so several keys on one account share them. content: application/json: schema: type: object properties: message: type: string examples: - Too Many Attempts. required: - message components: securitySchemes: http: type: http description: >- Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.