Skip to main content

Snapshot Instance

POST/api/instance/:instance_id/snapshot

Create a visible snapshot. The deployed route defaults to synchronous saves for omitted, null or empty bodies; sync=false retains the existing asynchronous contract. Singular and plural instance routes are aliases.

Request​

Path Parameters

  • instance_idstringrequired

Query Parameters

  • digeststring | null

application/json

Body

  • object | null

    Example: {"metadata":{},"sync":false}

    • digeststring | null

      Optional content digest. A non-empty body value takes precedence over the legacy digest query parameter.

    • metadataobject | null
      • Additional propertiesstring
    • syncboolean | null

      Omitted or null means synchronous on the deployed route; false uses the existing async path.

      Default: true

    • ttl_secondsinteger | null

      Optional positive snapshot lifetime in seconds.

      Minimum: 1

Responses​

Successful Response

application/json

Schema

  • object
    • createdintegerrequired

      Unix timestamp of when the snapshot was created

    • digeststring | null

      User provided digest of the snapshot content. Useful for caching if the snapshot takes a long time to create.

    • idstringrequired

      Unique identifier for the snapshot, like snapshot_xxxx

    • metadataobject

      User provided metadata for the snapshot

      • Additional propertiesstring
    • objectstring

      Object type, always 'snapshot'

      Value: "snapshot"

      Default: "snapshot"

    • refsobjectrequired
      • image_idstringrequired
    • specobjectrequired
      • disk_sizeintegerrequired

        Size of the snapshot in megabytes

      • memoryintegerrequired

        Memory of the snaphshot in megabytes

      • vcpusintegerrequired

        VCPU Count of the snaphshot

    • statusstringrequired

      Status of the snapshot

      Allowed values: "pending", "ready", "failed", "deleting", "deleted"

    • ttlobjectrequired

      Time to live settings for the snapshot. If not set, the snapshot will not expire.

      • ttl_expire_atinteger | null

        Unix timestamp of when the snapshot will expire

      • ttl_secondsinteger | nullrequired

        Time to live in seconds for the snapshot