> ## 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. # Order servers > ### Overview Orders servers using one quoted plan. Send `quote_token` and `quantity` from 1 to 10 with a matching `hostnames` list, or one `hostname` for a single server. Any hostname may be left blank, and the machine is then named after the IP address it is deployed onto. A matching `labels` list sets the panel display name of each server; any label left blank is randomly generated. Include the operating system, password and any SSH keys or setup script. Returns the purchase with one order per server. Payment from account credit and installation run in the background. Poll the outstanding orders for their status and server ID. Insufficient credit sets `needs_funds` until funds arrive or the payment deadline expires. Failed paid installations are refunded to account credit. ### Permissions Requires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404. ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json post /servers 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: post: tags: - Servers summary: Order servers description: >- ### Overview Orders servers using one quoted plan. Send `quote_token` and `quantity` from 1 to 10 with a matching `hostnames` list, or one `hostname` for a single server. Any hostname may be left blank, and the machine is then named after the IP address it is deployed onto. A matching `labels` list sets the panel display name of each server; any label left blank is randomly generated. Include the operating system, password and any SSH keys or setup script. Returns the purchase with one order per server. Payment from account credit and installation run in the background. Poll the outstanding orders for their status and server ID. Insufficient credit sets `needs_funds` until funds arrive or the payment deadline expires. Failed paid installations are refunded to account credit. ### Permissions Requires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404. operationId: serverOrder.store requestBody: description: >- Send a JSON object containing the fields below. Required fields are marked in the schema. required: true content: application/json: schema: examples: - quote_token: >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6IjNmYWRiNjgyM2ZmZTkyY2Q0ZDkwYzRkNjg4YTdjZWY5ZjBiYjBjZDE1YjVhM2VlMGE2MzMyZmU1YmQ4Njg1YWYiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NzI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCJ9.f84ed5bfb2e3e24710926d5ccf5902fc93d0c9a0a45365dd784e1aa72d4083f0 quantity: 1 hostname: null hostnames: - hev-telemetry.blackmesa.example.com labels: - hev-telemetry label: null template_uuid: e28b39a8-059e-4a75-8048-c9a6e7231b9f account_password: Resonance-Cascade-1998 ssh_keys: - 97721fd4-746a-40cc-8da0-4c9f623c112e user_script: 8edb21bc-9aee-4bd9-8a02-17043fa82a87 allOf: - $ref: '#/components/schemas/StoreServerOrderRequest' responses: '201': description: The record, as a JSON object. There is no envelope. content: application/json: schema: examples: - uuid: a930b81e-663e-4e12-a437-001f207d5ac6 status: pending status_label: Provisioning progress_message: null amount: '12.00' currency: USD quantity: 1 orders: - uuid: 0e6a7712-98ab-451b-8675-5c5ae96e4d3a purchase_uuid: a930b81e-663e-4e12-a437-001f207d5ac6 purchase_status: pending status: pending_payment status_label: Provisioning is_placed: false progress_message: null plan_name: Standard 4 GB plan_key: >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 vcpu_cores: 4 memory: 4000 disk: 80 bandwidth: 5000 hdd: false location: Kansas City, MO location_id: 3 group_name: Standard VPS hostname: hev-telemetry.blackmesa.example.com label: hev-telemetry template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png billing: service_id: null invoice_id: null invoice_url: null checkout_uuid: null invoice_status: null amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: null payment_window_minutes: 30 paid_at: null server_id: null can_cancel: true created_at: '2026-09-14T16:31:47+00:00' created_at: '2026-09-14T16:31:47+00:00' allOf: - $ref: '#/components/schemas/ServerPurchaseData' '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 '422': description: >- A field is missing or invalid, or the resource cannot accept this change in its current state. Check `message` for details. Field validation also includes an `errors` object keyed by field name. content: application/json: schema: type: object properties: message: type: string description: >- A summary of the validation error or the reason the change was refused. examples: - The name field is required. errors: type: object description: Validation errors grouped by field name. additionalProperties: type: array items: type: string 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: schemas: StoreServerOrderRequest: type: object examples: - quote_token: >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6IjNmYWRiNjgyM2ZmZTkyY2Q0ZDkwYzRkNjg4YTdjZWY5ZjBiYjBjZDE1YjVhM2VlMGE2MzMyZmU1YmQ4Njg1YWYiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NzI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCJ9.f84ed5bfb2e3e24710926d5ccf5902fc93d0c9a0a45365dd784e1aa72d4083f0 quantity: 1 hostname: null hostnames: - hev-telemetry.blackmesa.example.com labels: - hev-telemetry label: null template_uuid: e28b39a8-059e-4a75-8048-c9a6e7231b9f account_password: Resonance-Cascade-1998 ssh_keys: - 97721fd4-746a-40cc-8da0-4c9f623c112e user_script: 8edb21bc-9aee-4bd9-8a02-17043fa82a87 properties: quote_token: type: string description: The value of `quote_token`. maxLength: 20000 quantity: type: integer description: The value of `quantity`. minimum: 1 maximum: 10 hostname: type: - string - 'null' description: The fully qualified hostname. maxLength: 191 hostnames: type: array description: The value of `hostnames`. items: type: - string - 'null' maxLength: 191 minItems: 1 maxItems: 1 labels: type: array description: The value of `labels`. items: type: - string - 'null' maxLength: 40 minItems: 1 maxItems: 1 label: type: - string - 'null' description: A short label shown to customers. maxLength: 40 template_uuid: type: string description: The template uuid UUID. account_password: type: string description: The value of `account_password`. minLength: 5 maxLength: 191 ssh_keys: type: array description: The value of `ssh_keys`. items: type: string minLength: 36 maxLength: 36 maxItems: 25 user_script: type: - string - 'null' description: The value of `user_script`. minLength: 36 maxLength: 36 required: - quote_token - quantity - hostnames - template_uuid - account_password title: StoreServerOrderRequest ServerPurchaseData: type: object description: A server purchase with its cost, payment status and orders. examples: - uuid: a930b81e-663e-4e12-a437-001f207d5ac6 status: needs_funds status_label: Needs funds progress_message: >- Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue. amount: '12.00' currency: USD quantity: 1 orders: - uuid: 0e6a7712-98ab-451b-8675-5c5ae96e4d3a purchase_uuid: a930b81e-663e-4e12-a437-001f207d5ac6 purchase_status: needs_funds status: pending_payment status_label: Needs funds is_placed: false progress_message: >- Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue. plan_name: Standard 4 GB plan_key: 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 vcpu_cores: 4 memory: 4000 disk: 80 bandwidth: 5000 hdd: false location: Kansas City, MO location_id: 3 group_name: Standard VPS hostname: hev-telemetry.blackmesa.example.com label: hev-telemetry template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png billing: service_id: null invoice_id: null invoice_url: null checkout_uuid: null invoice_status: null amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: '2026-09-14T17:01:47+00:00' payment_window_minutes: 30 paid_at: null server_id: null can_cancel: true created_at: '2026-09-14T16:31:47+00:00' created_at: '2026-09-14T16:31:47+00:00' properties: uuid: type: string description: The uuid UUID. examples: - a930b81e-663e-4e12-a437-001f207d5ac6 status: type: string description: The value of `status`. enum: - pending - needs_funds - paid - refused - expired - cancelled examples: - needs_funds status_label: type: string description: The value of `status_label`. examples: - Needs funds progress_message: type: - string - 'null' description: The value of `progress_message`. examples: - >- Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue. amount: type: string description: The whole purchase, as a decimal string in `currency`. examples: - '12.00' currency: type: string description: The three-letter currency code used for monetary amounts. examples: - USD quantity: type: integer description: The value of `quantity`. examples: - 1 orders: type: array description: The value of `orders`. examples: - - uuid: 0e6a7712-98ab-451b-8675-5c5ae96e4d3a purchase_uuid: a930b81e-663e-4e12-a437-001f207d5ac6 purchase_status: needs_funds status: pending_payment status_label: Needs funds is_placed: false progress_message: >- Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue. plan_name: Standard 4 GB plan_key: >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 vcpu_cores: 4 memory: 4000 disk: 80 bandwidth: 5000 hdd: false location: Kansas City, MO location_id: 3 group_name: Standard VPS hostname: hev-telemetry.blackmesa.example.com label: hev-telemetry template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png billing: service_id: null invoice_id: null invoice_url: null checkout_uuid: null invoice_status: null amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: '2026-09-14T17:01:47+00:00' payment_window_minutes: 30 paid_at: null server_id: null can_cancel: true created_at: '2026-09-14T16:31:47+00:00' items: $ref: '#/components/schemas/ServerOrderData' created_at: type: - string - 'null' description: The date and time for created at, in UTC. examples: - '2026-09-14T16:31:47+00:00' required: - uuid - status - status_label - progress_message - amount - currency - quantity - orders - created_at title: ServerPurchaseData ServerOrderData: type: object description: A server order and its installation progress. examples: - uuid: 0e6a7712-98ab-451b-8675-5c5ae96e4d3a purchase_uuid: a930b81e-663e-4e12-a437-001f207d5ac6 purchase_status: needs_funds status: pending_payment status_label: Needs funds is_placed: false progress_message: >- Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue. plan_name: Standard 4 GB plan_key: 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 vcpu_cores: 4 memory: 4000 disk: 80 bandwidth: 5000 hdd: false location: Kansas City, MO location_id: 3 group_name: Standard VPS hostname: hev-telemetry.blackmesa.example.com label: hev-telemetry template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png billing: service_id: null invoice_id: null invoice_url: null checkout_uuid: null invoice_status: null amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: '2026-09-14T17:01:47+00:00' payment_window_minutes: 30 paid_at: null server_id: null can_cancel: true created_at: '2026-09-14T16:31:47+00:00' properties: uuid: type: string description: The uuid UUID. examples: - 0e6a7712-98ab-451b-8675-5c5ae96e4d3a purchase_uuid: type: - string - 'null' description: >- The checkout this machine was bought in, shared with every other machine ordered at the same time. examples: - a930b81e-663e-4e12-a437-001f207d5ac6 purchase_status: type: - string - 'null' description: The purchase status, or null for an order without a purchase record. enum: - pending - needs_funds - paid - refused - expired - cancelled - null examples: - needs_funds status: type: string description: The value of `status`. enum: - pending_payment - provisioning - configuring - completed - expired - payment_review - failed - cancelled examples: - pending_payment status_label: type: string description: The value of `status_label`. examples: - Needs funds is_placed: type: boolean description: >- Whether the billing system has taken and been paid for this order, which is what separates "still placing" from "being built". examples: - false progress_message: type: - string - 'null' description: The value of `progress_message`. examples: - >- Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue. plan_name: type: string description: The value of `plan_name`. examples: - Standard 4 GB plan_key: type: string description: The value of `plan_key`. examples: - 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 vcpu_cores: type: integer description: The value of `vcpu_cores`. examples: - 4 memory: type: integer description: The value of `memory`. examples: - 4000 disk: type: integer description: The value of `disk`. examples: - 80 bandwidth: type: integer description: The value of `bandwidth`. examples: - 5000 hdd: type: boolean description: The value of `hdd`. examples: - false location: type: - string - 'null' description: The value of `location`. examples: - Kansas City, MO location_id: type: - integer - 'null' description: The location id ID. examples: - 3 group_name: type: - string - 'null' description: The value of `group_name`. examples: - Standard VPS hostname: type: string description: The fully qualified hostname. examples: - hev-telemetry.blackmesa.example.com label: type: - string - 'null' description: A short label shown to customers. examples: - hev-telemetry template_name: type: - string - 'null' description: The value of `template_name`. examples: - Ubuntu 24.04 template_icon_url: type: - string - 'null' description: The value of `template_icon_url`. examples: - https://img.icons8.com/color/48/ubuntu.png billing: $ref: '#/components/schemas/BillingData' description: The value of `billing`. examples: - service_id: null invoice_id: null invoice_url: null checkout_uuid: null invoice_status: null amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: '2026-09-14T17:01:47+00:00' payment_window_minutes: 30 paid_at: null server_id: type: - string - 'null' description: >- The installed server's short ID, or null until installation finishes. examples: - null can_cancel: type: boolean description: Whether the customer can cancel. examples: - true created_at: type: - string - 'null' description: The date and time for created at, in UTC. examples: - '2026-09-14T16:31:47+00:00' required: - uuid - purchase_uuid - purchase_status - status - status_label - is_placed - progress_message - plan_name - plan_key - vcpu_cores - memory - disk - bandwidth - hdd - location - location_id - group_name - hostname - label - template_name - template_icon_url - billing - server_id - can_cancel - created_at title: ServerOrderData BillingData: type: object description: >- The billing details shared by customer-owned resources and pending orders. examples: - service_id: 7312 invoice_id: 15542 invoice_url: null checkout_uuid: null invoice_status: Paid amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: null payment_window_minutes: null paid_at: '2026-03-02T19:13:58+00:00' properties: service_id: type: - integer - 'null' description: The customer's service number, once a recurring service exists. examples: - 7312 invoice_id: type: - integer - 'null' description: The customer's invoice number, once an invoice exists. examples: - 15542 invoice_url: type: - string - 'null' description: A complete URL where the invoice can be paid. examples: - null checkout_uuid: type: - string - 'null' description: The checkout UUID, or null when no checkout is available. examples: - null invoice_status: type: - string - 'null' description: The current invoice status, or null before an invoice exists. examples: - Paid amount: type: - string - 'null' description: The amount in the currency shown by `currency`. examples: - '12.00' currency: type: - string - 'null' description: The three-letter currency code used for `amount`. examples: - USD billing_cycle: type: - string - 'null' description: How often the service renews, or null for a one-time charge. examples: - monthly payment_due_at: type: - string - 'null' description: When payment is due before the reservation is released. examples: - null payment_window_minutes: type: - integer - 'null' description: How many minutes the original payment window allowed. examples: - null paid_at: type: - string - 'null' description: When the charge was paid, or null while payment is outstanding. examples: - '2026-03-02T19:13:58+00:00' required: - service_id - invoice_id - invoice_url - checkout_uuid - invoice_status - amount - currency - billing_cycle - payment_due_at - payment_window_minutes - paid_at title: BillingData 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.