> ## 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. # Get a quote for a server order > ### Overview Calculates a server price and returns a signed `quote_token`. Send `plan_key` from the catalogue. Optionally send `billing_cycle` to use a cycle other than the default. The response includes the plan, product group, location, price, currency, billing cycle, cycle length in months and payment window. Use the token to place the order at the quoted price. Requesting a quote does not charge the account or reserve capacity. ### 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 post /servers/quote 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/quote: post: tags: - Servers summary: Get a quote for a server order description: >- ### Overview Calculates a server price and returns a signed `quote_token`. Send `plan_key` from the catalogue. Optionally send `billing_cycle` to use a cycle other than the default. The response includes the plan, product group, location, price, currency, billing cycle, cycle length in months and payment window. Use the token to place the order at the quoted price. Requesting a quote does not charge the account or reserve capacity. ### Permissions Requires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404. operationId: serverOrder.quote requestBody: description: >- Send a JSON object containing the fields below. Required fields are marked in the schema. required: true content: application/json: schema: examples: - plan_key: >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 billing_cycle: monthly allOf: - $ref: '#/components/schemas/QuoteServerOrderRequest' responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: type: object examples: - plan: key: >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 id: standard-4gb name: Standard 4 GB vcpu_cores: 4 memory: 4000 disk: 80 bandwidth: 5000 hdd: false primary_disk: 80 hdd_disk: 0 price: '12.00' deployment_time: Instant whmcs_id: '48' plan_key: >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 group: id: '2' name: Standard VPS location: 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 amount: '12.00' currency: USD billing_cycle: monthly billing_cycle_months: 1 payment_window_minutes: 30 quote_token: >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6IjNmYWRiNjgyM2ZmZTkyY2Q0ZDkwYzRkNjg4YTdjZWY5ZjBiYjBjZDE1YjVhM2VlMGE2MzMyZmU1YmQ4Njg1YWYiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NzI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCJ9.f84ed5bfb2e3e24710926d5ccf5902fc93d0c9a0a45365dd784e1aa72d4083f0 properties: plan: type: object description: The value of `plan`. examples: - key: >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 id: standard-4gb name: Standard 4 GB vcpu_cores: 4 memory: 4000 disk: 80 bandwidth: 5000 hdd: false primary_disk: 80 hdd_disk: 0 price: '12.00' deployment_time: Instant whmcs_id: '48' properties: key: type: string description: The value of `key`. examples: - >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 id: type: string description: The id ID. examples: - standard-4gb name: type: string description: The name shown to customers. examples: - Standard 4 GB vcpu_cores: type: integer description: The value of `vcpu_cores`. examples: - 4 memory: type: integer description: Memory in advertised units; 1000 represents 1 GiB. examples: - 4000 disk: type: integer description: Advertised disk capacity in GiB. examples: - 80 bandwidth: type: integer description: >- Transfer allowance in advertised units; 1000 represents 1 TiB and zero means unlimited. examples: - 5000 hdd: type: boolean description: The value of `hdd`. examples: - false primary_disk: type: integer description: Primary disk capacity in GiB. examples: - 80 hdd_disk: type: integer description: Secondary hard disk capacity in GiB. examples: - 0 price: type: string description: The value of `price`. examples: - '12.00' deployment_time: type: - string - 'null' description: The value of `deployment_time`. examples: - Instant whmcs_id: type: string description: The billing product identifier. examples: - '48' required: - key - id - name - vcpu_cores - memory - disk - bandwidth - hdd - primary_disk - hdd_disk - price - deployment_time - whmcs_id plan_key: type: string description: The value of `plan_key`. examples: - >- 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 group: type: object description: The value of `group`. examples: - id: '2' name: Standard VPS properties: id: type: string description: The id ID. examples: - '2' name: type: string description: The name shown to customers. examples: - Standard VPS required: - id - name location: type: object description: The value of `location`. examples: - id: 2-3 display_name: Kansas City, MO name: Kansas City, MO flag_url: null cid: 3 group_name: Standard VPS 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 required: - id - display_name - name - flag_url - cid - group_name location_id: type: - integer - 'null' description: The location id ID. examples: - 3 product_group_id: type: - integer - 'null' description: The product group id ID. examples: - 2 amount: type: string description: The amount in the currency shown by `currency`. examples: - '12.00' currency: type: string description: The three-letter currency code used for monetary amounts. examples: - USD billing_cycle: type: string description: How often the service renews and is billed. examples: - monthly billing_cycle_months: type: integer description: The value of `billing_cycle_months`. examples: - 1 payment_window_minutes: type: integer description: How many minutes the original payment window allowed. examples: - 30 quote_token: type: string description: The value of `quote_token`. examples: - >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6IjNmYWRiNjgyM2ZmZTkyY2Q0ZDkwYzRkNjg4YTdjZWY5ZjBiYjBjZDE1YjVhM2VlMGE2MzMyZmU1YmQ4Njg1YWYiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NzI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCJ9.f84ed5bfb2e3e24710926d5ccf5902fc93d0c9a0a45365dd784e1aa72d4083f0 required: - plan - plan_key - group - location - location_id - product_group_id - amount - currency - billing_cycle - billing_cycle_months - payment_window_minutes - quote_token '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: QuoteServerOrderRequest: type: object examples: - plan_key: 032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4 billing_cycle: monthly properties: plan_key: type: string description: The value of `plan_key`. minLength: 64 maxLength: 64 billing_cycle: type: string description: How often the service renews and is billed. enum: - monthly - quarterly - semiannually - annually - biennially - triennially required: - plan_key title: QuoteServerOrderRequest 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.