> ## 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. # Take a snapshot > ### Overview Creates a snapshot in the background. Send a `name` of 1 to 40 characters and the UUID of the `snapshot_storage` to store it in. You can leave out the storage when the team has exactly one usable storage. The storage must not be full, suspended or ended. The request is refused while a backup or migration of the server is running. The initial response has `completed_at` set to null. The snapshot is ready when `completed_at` is set and `is_successful` is true, and its size then counts against the storage. ### Permissions Requires the `snapshot.create` (Take snapshots) permission for the selected team. Resources outside that team return 404. ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json post /servers/{server}/snapshots 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}/snapshots: post: tags: - Snapshots summary: Take a snapshot description: >- ### Overview Creates a snapshot in the background. Send a `name` of 1 to 40 characters and the UUID of the `snapshot_storage` to store it in. You can leave out the storage when the team has exactly one usable storage. The storage must not be full, suspended or ended. The request is refused while a backup or migration of the server is running. The initial response has `completed_at` set to null. The snapshot is ready when `completed_at` is set and `is_successful` is true, and its size then counts against the storage. ### Permissions Requires the `snapshot.create` (Take snapshots) permission for the selected team. Resources outside that team return 404. operationId: snapshot.store parameters: - name: server in: path required: true description: The server UUID schema: type: string examples: - ecc6f4f1 example: ecc6f4f1 requestBody: description: >- Send a JSON object containing the fields below. Required fields are marked in the schema. required: true content: application/json: schema: examples: - name: Before anti-mass spectrometer run snapshot_storage: 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 allOf: - $ref: '#/components/schemas/StoreSnapshotRequest' responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: examples: - uuid: c9380e36-eaa8-4391-a443-85f9dfb5a16b name: Before anti-mass spectrometer run status: creating is_successful: false is_available: true size: 0 disk_allocated: 85899345920 disk_used: null completed_at: null created_at: '2026-09-14T16:42:09.000000Z' server: uuid: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b uuid_short: ecc6f4f1 name: lambda-core windows: false template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png server_name: lambda-core storage: uuid: 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 name: Storage 1 is_suspended: false allOf: - $ref: '#/components/schemas/SnapshotData' '400': description: >- The storage is full, suspended or not active, no storage was named and the team does not have exactly one, or this location cannot take snapshots. content: application/json: schema: type: object properties: message: type: string examples: - The request could not be carried out. required: - message '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 '409': description: >- The server is suspended, installing or busy with another operation. The message explains why. content: application/json: schema: type: object properties: message: type: string examples: - The request could not be carried out. 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: StoreSnapshotRequest: type: object examples: - name: Before anti-mass spectrometer run snapshot_storage: 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 properties: name: type: string description: The name shown to customers. minLength: 1 maxLength: 40 snapshot_storage: type: - string - 'null' format: uuid description: The value of `snapshot_storage`. required: - name title: StoreSnapshotRequest SnapshotData: type: object description: A saved copy of a server's disk state. examples: - uuid: 2305595e-9b2f-4f9e-96d7-47fc7ff45791 name: Pre-cascade baseline status: available is_successful: true is_available: true size: 85899345920 disk_allocated: 85899345920 disk_used: 33822867456 completed_at: '2026-09-12T22:07:13.000000Z' created_at: '2026-09-12T22:05:47.000000Z' server: uuid: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b uuid_short: ecc6f4f1 name: lambda-core windows: false template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png server_name: lambda-core storage: uuid: 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 name: Storage 1 is_suspended: false properties: uuid: type: string description: The uuid UUID. examples: - 2305595e-9b2f-4f9e-96d7-47fc7ff45791 name: type: string description: The name shown to customers. examples: - Pre-cascade baseline status: type: string description: >- The state as the customer reads it, including a suspension of the storage holding the snapshot. enum: - creating - available - failed - unavailable - suspended - restoring examples: - available is_successful: type: boolean description: Whether the resource is successful. examples: - true is_available: type: boolean description: Whether the resource is available. examples: - true size: type: - integer - 'null' description: The value of `size`. examples: - 85899345920 disk_allocated: type: - integer - 'null' description: What the VM's disk was provisioned at when the snapshot was taken. examples: - 85899345920 disk_used: type: - integer - 'null' description: How much of that disk is in use on the VM right now. examples: - 33822867456 completed_at: type: - string - 'null' format: date-time description: The date and time for completed at, in UTC. examples: - '2026-09-03T04:21:17.000000Z' - '2026-09-12T22:07:13.000000Z' created_at: type: - string - 'null' format: date-time description: The date and time for created at, in UTC. examples: - '2026-09-03T04:21:17.000000Z' - '2026-09-12T22:05:47.000000Z' server: description: >- The machine it was taken of, while that machine exists and is still the same account's. A snapshot outlives its server, and one moved to another account with its storage does not reveal the seller's machine. examples: - uuid: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b uuid_short: ecc6f4f1 name: lambda-core windows: false template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png anyOf: - $ref: '#/components/schemas/SnapshotServerData' - type: 'null' server_name: type: - string - 'null' description: What the machine was called when the snapshot was taken. examples: - lambda-core storage: description: The snapshot storage holding it and paying for it. examples: - uuid: 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 name: Storage 1 is_suspended: false anyOf: - $ref: '#/components/schemas/SnapshotStorageSummaryData' - type: 'null' required: - uuid - name - status - is_successful - is_available - size - disk_allocated - disk_used - completed_at - created_at - server - server_name - storage title: SnapshotData SnapshotServerData: type: object description: The server a snapshot was taken from. examples: - uuid: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b uuid_short: ecc6f4f1 name: lambda-core windows: false template_name: Ubuntu 24.04 template_icon_url: https://img.icons8.com/color/48/ubuntu.png properties: uuid: type: string description: The uuid UUID. examples: - ecc6f4f1-c89b-4dce-a20b-a330641c5b0b uuid_short: type: string description: The value of `uuid_short`. examples: - ecc6f4f1 name: type: string description: The name shown to customers. examples: - lambda-core windows: type: boolean description: The value of `windows`. examples: - false 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 required: - uuid - uuid_short - name - windows - template_name - template_icon_url title: SnapshotServerData SnapshotStorageSummaryData: type: object description: The snapshot storage holding a snapshot, and whether it is suspended. examples: - uuid: 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 name: Storage 1 is_suspended: false properties: uuid: type: string description: The uuid UUID. examples: - 9e83397b-d88e-43ae-bfb7-a8c2e6eda853 name: type: string description: The name shown to customers. examples: - Storage 1 is_suspended: type: boolean description: Whether the resource is suspended. examples: - false required: - uuid - name - is_suspended title: SnapshotStorageSummaryData 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.