NexGen Cloud Snapshots API

openapi: 3.2.0
info:
  title: Nexgen Cloud Snapshots API
  version: '1.0'
  description: 'Operations tagged Snapshots across 2 of this provider''s published API definitions: nexgen-cloud-hyperstack-openapi.json, nexgen-cloud-infrahub-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://infrahub-api.nexgencloud.com/v1
tags:
- name: Snapshots
  description: A snapshot is a point-in-time copy of a virtual machine or volume. Snapshots are stored in the same region as the source resource and can be used to clone, restore, or migrate state. Snapshot creation is non-blocking, the source VM remains running while the snapshot completes in the background.
paths:
  /core/snapshots:
    get:
      tags:
      - Snapshots
      summary: Retrieve list of snapshots with pagination
      description: Retrieves a list of your current snapshots. See [Snapshots](https://docs.hyperstack.cloud/docs/api-reference/snapshots) for more information.
      operationId: List_snapshots
      parameters:
      - name: page
        in: query
        description: Page number of results to return.
        schema:
          type: integer
      - name: pageSize
        in: query
        description: Data Per Page
        schema:
          type: integer
      - name: search
        in: query
        description: Search By Snapshot ID or Name
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshots'
              example:
                status: true
                message: Successfully retrieved Snapshots
                page: null
                page_size: null
                count: 3
                snapshots:
                - id: 9876
                  name: example-snapshot
                  description: Example snapshot
                  vm_id: 5341
                  region_id: 1402
                  status: SUCCESS
                  is_image: true
                  size: 4
                  has_floating_ip: false
                  labels: []
                  created_at: '2026-05-07T09:21:55Z'
                  updated_at: '2026-05-07T09:21:55Z'
                  region: NORWAY-1
                  vm_name: example-vm
                  vm_status: DELETED
                  vm_environment:
                    id: 7613
                    name: example-environment
                    region: NORWAY-1
                    created_at: '2026-05-06T15:18:42Z'
                    features:
                      network_optimised: false
                      green_status: GREEN
                  vm_flavor:
                    id: 1129
                    name: n1-cpu-small
                    display_name: null
                    region_name: NORWAY-1
                    cpu: 4
                    ram: 4
                    disk: 100
                    ephemeral: 0
                    gpu: ''
                    gpu_count: 0
                    created_at: '2026-05-06T15:18:42Z'
                    labels: []
                    features:
                      network_optimised: false
                      no_reboot: false
                      no_hibernation: false
                      no_snapshot: false
                      local_storage_only: false
                      api_only: false
                  vm_image:
                    id: 7613
                    name: Ubuntu Server 24.04 LTS (Noble Numbat)
                    region_name: NORWAY-1
                    type: Ubuntu
                    version: Server 24.04 LTS (Noble Numbat)
                    size: 26843545600
                    display_size: 25 GiB
                    description: ''
                    snapshot: null
                    is_public: true
                    created_at: '2026-05-06T15:18:42Z'
                    labels: []
                  vm_keypair:
                    id: 8429
                    name: example-keypair
                    environment:
                      id: 4501
                      name: example-environment
                      features:
                        network_optimised: false
                        green_status: GREEN
                    public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMnm2XM9Vs1RA6mV20c7wGO3/H5eMR+3ReROywj7iyg+ user@example.com
                    fingerprint: 72:0a:c4:28:24:f8:3e:ab:c4:a5:a6:93:15:15:a9:e8
                    created_at: '2026-05-07T09:21:55Z'
                  volume_id: null
                  volume_name: null
                  custom_image:
                    id: 7613
                    name: example-img-1786
                    region_name: NORWAY-1
                    type: Snapshot
                    version: example-snapshot
                    size: 4294967296
                    description: null
                    is_public: false
                    created_at: '2026-05-06T15:18:42Z'
                    labels: []
              examples:
                default:
                  summary: Successful response
                  value:
                    status: true
                    message: Successfully retrieved Snapshots
                    page: null
                    page_size: null
                    count: 3
                    snapshots:
                    - id: 9876
                      name: example-snapshot
                      description: Example snapshot
                      vm_id: 5341
                      region_id: 1402
                      status: SUCCESS
                      is_image: true
                      size: 4
                      has_floating_ip: false
                      labels: []
                      created_at: '2026-05-07T09:21:55Z'
                      updated_at: '2026-05-07T09:21:55Z'
                      region: NORWAY-1
                      vm_name: example-vm
                      vm_status: DELETED
                      vm_environment:
                        id: 7613
                        name: example-environment
                        region: NORWAY-1
                        created_at: '2026-05-06T15:18:42Z'
                        features:
                          network_optimised: false
                          green_status: GREEN
                      vm_flavor:
                        id: 1129
                        name: n1-cpu-small
                        display_name: null
                        region_name: NORWAY-1
                        cpu: 4
                        ram: 4
                        disk: 100
                        ephemeral: 0
                        gpu: ''
                        gpu_count: 0
                        created_at: '2026-05-06T15:18:42Z'
                        labels: []
                        features:
                          network_optimised: false
                          no_reboot: false
                          no_hibernation: false
                          no_snapshot: false
                          local_storage_only: false
                          api_only: false
                      vm_image:
                        id: 7613
                        name: Ubuntu Server 24.04 LTS (Noble Numbat)
                        region_name: NORWAY-1
                        type: Ubuntu
                        version: Server 24.04 LTS (Noble Numbat)
                        size: 26843545600
                        display_size: 25 GiB
                        description: ''
                        snapshot: null
                        is_public: true
                        created_at: '2026-05-06T15:18:42Z'
                        labels: []
                      vm_keypair:
                        id: 8429
                        name: example-keypair
                        environment:
                          id: 4501
                          name: example-environment
                          features:
                            network_optimised: false
                            green_status: GREEN
                        public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMnm2XM9Vs1RA6mV20c7wGO3/H5eMR+3ReROywj7iyg+ user@example.com
                        fingerprint: 72:0a:c4:28:24:f8:3e:ab:c4:a5:a6:93:15:15:a9:e8
                        created_at: '2026-05-07T09:21:55Z'
                      volume_id: null
                      volume_name: null
                      custom_image:
                        id: 7613
                        name: example-img-1786
                        region_name: NORWAY-1
                        type: Snapshot
                        version: example-snapshot
                        size: 4294967296
                        description: null
                        is_public: false
                        created_at: '2026-05-06T15:18:42Z'
                        labels: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples: {}
      security:
      - apiKey: []
    servers:
    - url: https://infrahub-api.nexgencloud.com/v1
  /core/snapshots/name-availability/{name}:
    get:
      tags:
      - Snapshots
      summary: Fetch snapshot name availability
      description: Check if a Snapshot name is available.
      operationId: Fetch_snapshot_name_availability
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: Name of the snapshot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailableModel'
              example:
                name: example-availability-check
                available: true
                message: This name is available
              examples:
                default:
                  summary: Successful response
                  value:
                    name: example-availability-check
                    available: true
                    message: This name is available
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples: {}
      security:
      - apiKey: []
    servers:
    - url: https://infrahub-api.nexgencloud.com/v1
  /core/snapshots/{id}:
    get:
      tags:
      - Snapshots
      summary: Retrieve a snapshot
      description: Retrieve details of a snapshot. See [Snapshots](https://docs.hyperstack.cloud/docs/api-reference/snapshots) for more information.
      operationId: Get_snapshot
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: ID of the snapshot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotRetrieve'
              example:
                status: 200
                message: Retrieved snapshot 1789
                snapshot:
                  id: 2058
                  name: example-snapshot
                  description: Example snapshot
                  vm_id: 7613
                  region_id: 9876
                  status: SUCCESS
                  is_image: true
                  size: 4
                  has_floating_ip: false
                  labels: []
                  created_at: '2026-05-07T11:47:30Z'
                  updated_at: '2026-05-07T11:47:30Z'
                  region: NORWAY-1
                  vm_name: example-vm
                  vm_status: SHUTOFF
                  vm_environment:
                    id: 3287
                    name: example-environment
                    region: NORWAY-1
                    created_at: '2026-05-06T16:04:09Z'
                    features:
                      network_optimised: false
                      green_status: GREEN
                  vm_flavor:
                    id: 1402
                    name: n1-cpu-small
                    display_name: null
                    region_name: NORWAY-1
                    cpu: 4
                    ram: 4
                    disk: 100
                    ephemeral: 0
                    gpu: ''
                    gpu_count: 0
                    created_at: '2026-05-06T16:04:09Z'
                    labels: []
                    features:
                      network_optimised: false
                      no_reboot: false
                      no_hibernation: false
                      no_snapshot: false
                      local_storage_only: false
                      api_only: false
                  vm_image:
                    id: 3287
                    name: Ubuntu Server 24.04 LTS (Noble Numbat)
                    region_name: NORWAY-1
                    type: Ubuntu
                    version: Server 24.04 LTS (Noble Numbat)
                    size: 26843545600
                    display_size: 25 GiB
                    description: ''
                    snapshot: null
                    is_public: true
                    created_at: '2026-05-06T16:04:09Z'
                    labels: []
                  vm_keypair:
                    id: 4501
                    name: example-keypair
                    environment:
                      id: 6190
                      name: example-environment
                      features:
                        network_optimised: false
                        green_status: GREEN
                    public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJz0qO97NM7sZzUGT0z+eddAXg8BTYr1dz5LD8QyCmg1 user@example.com
                    fingerprint: ea:85:b4:6e:a8:75:a1:17:10:51:f5:a2:65:7e:1f:c0
                    created_at: '2026-05-07T11:47:30Z'
                  volume_id: null
                  volume_name: null
                  custom_image:
                    id: 3287
                    name: example-img-1789
                    region_name: NORWAY-1
                    type: Snapshot
                    version: example-snapshot
                    size: 4294967296
                    description: null
                    is_public: false
                    created_at: '2026-05-06T16:04:09Z'
                    labels: []
              examples:
                default:
                  summary: Successful response
                  value:
                    status: 200
                    message: Retrieved snapshot 1789
                    snapshot:
                      id: 2058
                      name: example-snapshot
                      description: Example snapshot
                      vm_id: 7613
                      region_id: 9876
                      status: SUCCESS
                      is_image: true
                      size: 4
                      has_floating_ip: false
                      labels: []
                      created_at: '2026-05-07T11:47:30Z'
                      updated_at: '2026-05-07T11:47:30Z'
                      region: NORWAY-1
                      vm_name: example-vm
                      vm_status: SHUTOFF
                      vm_environment:
                        id: 3287
                        name: example-environment
                        region: NORWAY-1
                        created_at: '2026-05-06T16:04:09Z'
                        features:
                          network_optimised: false
                          green_status: GREEN
                      vm_flavor:
                        id: 1402
                        name: n1-cpu-small
                        display_name: null
                        region_name: NORWAY-1
                        cpu: 4
                        ram: 4
                        disk: 100
                        ephemeral: 0
                        gpu: ''
                        gpu_count: 0
                        created_at: '2026-05-06T16:04:09Z'
                        labels: []
                        features:
                          network_optimised: false
                          no_reboot: false
                          no_hibernation: false
                          no_snapshot: false
                          local_storage_only: false
                          api_only: false
                      vm_image:
                        id: 3287
                        name: Ubuntu Server 24.04 LTS (Noble Numbat)
                        region_name: NORWAY-1
                        type: Ubuntu
                        version: Server 24.04 LTS (Noble Numbat)
                        size: 26843545600
                        display_size: 25 GiB
                        description: ''
                        snapshot: null
                        is_public: true
                        created_at: '2026-05-06T16:04:09Z'
                        labels: []
                      vm_keypair:
                        id: 4501
                        name: example-keypair
                        environment:
                          id: 6190
                          name: example-environment
                          features:
                            network_optimised: false
                            green_status: GREEN
                        public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJz0qO97NM7sZzUGT0z+eddAXg8BTYr1dz5LD8QyCmg1 user@example.com
                        fingerprint: ea:85:b4:6e:a8:75:a1:17:10:51:f5:a2:65:7e:1f:c0
                        created_at: '2026-05-07T11:47:30Z'
                      volume_id: null
                      volume_name: null
                      custom_image:
                        id: 3287
                        name: example-img-1789
                        region_name: NORWAY-1
                        type: Snapshot
                        version: example-snapshot
                        size: 4294967296
                        description: null
                        is_public: false
                        created_at: '2026-05-06T16:04:09Z'
                        labels: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples: {}
      security:
      - apiKey: []
    delete:
      tags:
      - Snapshots
      summary: Delete snapshot
      description: Delete a snapshot. Provide the snapshot ID in the path to delete the specified snapshot. If the snapshot is connected with an image, that image will also be deleted and the deleted image ID will be returned in the success message response.
      operationId: Delete_snapshot
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: ID of the snapshot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
              example:
                status: true
                message: Snapshot 1789 is being deleted
              examples:
                default:
                  summary: Successful response
                  value:
                    status: true
                    message: Snapshot 1789 is being deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples: {}
      security:
      - apiKey: []
    servers:
    - url: https://infrahub-api.nexgencloud.com/v1
  /core/snapshots/{id}/restore:
    post:
      tags:
      - Snapshots
      summary: Restore a snapshot
      description: 'Restore a snapshot to a new virtual machine. Supply the snapshot ID in the path to restore the specified snapshot.


        > **State requirement:** This operation requires the snapshot to be in the `COMPLETE` state.'
      operationId: Restore_snapshot
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: ID of the snapshot.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotRestoreRequest'
              example:
                new_vm_name: example-restored-1789
              properties: {}
            example:
              new_vm_name: example-restored-1789
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instance'
              example:
                status: true
                message: VM is scheduled for creation.
                instances:
                - id: 7613
                  name: example-restored-1789
                  status: CREATING
                  environment:
                    id: 3287
                    name: example-environment
                    org_id: 6190
                    region: NORWAY-1
                    features:
                      network_optimised: false
                      green_status: GREEN
                  image: null
                  flavor:
                    id: 1402
                    name: n1-cpu-small
                    cpu: 4
                    ram: 4
                    disk: 100
                    ephemeral: 0
                    gpu: ''
                    gpu_count: 0
                    labels: []
                    features:
                      network_optimised: false
                      no_reboot: false
                      no_hibernation: false
                      no_snapshot: false
                      local_storage_only: false
                      api_only: false
                  os: Ubuntu Server 24.04 LTS (Noble Numbat)
                  keypair:
                    name: example-keypair
                  volume_attachments: []
                  power_state: null
                  vm_state: null
                  fixed_ip: null
                  floating_ip: null
                  floating_ip_status: NO FLOATING IP
                  security_rules: []
                  callback_url: null
                  locked: false
                  contract_id: null
                  labels: []
                  created_at: '2026-05-06T15:18:42Z'
                  features:
                    network_optimised: false
                    green_status: GREEN
                  is_snapshotting: false
                  cluster_id: null
                  port_randomization: true
                  port_randomization_status: NO_FLOATING_IP
                  requires_public_ip: false
              examples:
                default:
                  summary: Successful response
                  value:
                    status: true
                    message: VM is scheduled for creation.
                    instances:
                    - id: 7613
                      name: example-restored-1789
                      status: CREATING
                      environment:
                        id: 3287
                        name: example-environment
                        org_id: 6190
                        region: NORWAY-1
                        features:
                          network_optimised: false
                          green_status: GREEN
                      image: null
                      flavor:
                        id: 1402
                        name: n1-cpu-small
                        cpu: 4
                        ram: 4
                        disk: 100
                        ephemeral: 0
                        gpu: ''
                        gpu_count: 0
                        labels: []
                        features:
                          network_optimised: false
                          no_reboot: false
                          no_hibernation: false
                          no_snapshot: false
                          local_storage_only: false
                          api_only: false
                      os: Ubuntu Server 24.04 LTS (Noble Numbat)
                      keypair:
                        name: example-keypair
                      volume_attachments: []
                      power_state: null
                      vm_state: null
                      fixed_ip: null
                      floating_ip: null
                      floating_ip_status: NO FLOATING IP
                      security_rules: []
                      callback_url: null
                      locked: false
                      contract_id: null
                      labels: []
                      created_at: '2026-05-06T15:18:42Z'
                      features:
                        network_optimised: false
                        green_status: GREEN
                      is_snapshotting: false
                      cluster_id: null
                      port_randomization: true
                      port_randomization_status: NO_FLOATING_IP
                      requires_public_ip: false
        '400':
          description: 'Bad Request


            Common cause: `error_reason: bad_request`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples:
                default:
                  summary: Bad Request
                  value:
                    status: false
                    message: Snapshot 1785 is not ready to be restored
                    error_reason: bad_request
              example:
                status: false
                message: Snapshot 1785 is not ready to be restored
                error_reason: bad_request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples: {}
      security:
      - apiKey: []
    servers:
    - url: https://infrahub-api.nexgencloud.com/v1
  /core/snapshots/{snapshot_id}/events:
    get:
      tags:
      - Snapshots
      summary: Fetch all events for a snapshot
      description: Retrieves a list of all events for a Snapshot's history, which records actions performed on the specific snapshot. Requires the snapshot ID in the path.
      operationId: List_Snapshot_Events
      parameters:
      - name: snapshot_id
        in: path
        required: true
        schema:
          type: integer
        description: ID of the snapshot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                status: true
                message: Successfully retrieved events for Snapshot example-snapshot
                snapshot_events:
                - id: 2058
                  snapshot_id: 4501
                  user_id: 7613
                  org_id: 3287
                  time: '2026-05-07T11:47:30Z'
                  type: normal
                  reason: SnapshotCreateRequest
                  object: example-snapshot
                  message: Snapshot example-snapshot Creation Request from Instance example-vm Sent.
              examples:
                default:
                  summary: Successful response
                  value:
                    status: true
                    message: Successfully retrieved events for Snapshot example-snapshot
                    snapshot_events:
                    - id: 2058
                      snapshot_id: 4501
                      user_id: 7613
                      org_id: 3287
                      time: '2026-05-07T11:47:30Z'
                      type: normal
                      reason: SnapshotCreateRequest
                      object: example-snapshot
                      message: Snapshot example-snapshot Creation Request from Instance example-vm Sent.
      security:
      - apiKey: []
    servers:
    - url: https://infrahub-api.nexgencloud.com/v1
  /core/snapshots/{snapshot_id}/image:
    post:
      tags:
      - Snapshots
      summary: Create an image from a snapshot
      description: Creates a image from a specified snapshot. For more information about images, see [Image](https://docs.hyperstack.cloud/docs/api-reference/image). For more information about snapshots, see [Snapshot](https://docs.hyperstack.cloud/docs/api-reference/snapshots).
      operationId: Create_custom_image
      parameters:
      - name: snapshot_id
        in: path
        required: true
        schema:
          type: integer
        description: ID of the snapshot.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImagePayload'
              example:
                name: example-img-1789
              properties: {}
            example:
              name: example-img-1789
        required: true
      responses:
        '200':
          description: Creation of image successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Create_Image'
              example:
                status: true
                message: Image added successfully.
                image:
                  id: 4501
                  name: example-img-1789
                  openstack_id: f3a91c44-7b2e-49d7-a16d-5c3e8d9a0b21
                  region_id: 8429
                  region_name: NORWAY-1
                  type: Snapshot
                  version: example-snapshot
                  size: 4294967296
                  display_size: 4 GiB
                  is_public: false
                  org_ids:
                  - 3971
                  description: null
                  labels: []
                  created_at: '2026-05-07T11:47:30Z'
                  deleted: false
                  snapshot_id: 2058
                  unlisted: false
                  organizations:
                  - 3971
              examples:
                default:
                  summary: Successful respon

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nexgen-cloud/refs/heads/main/openapi/nexgen-cloud-snapshots-api-openapi.yml