Skip to content
DashboardGet API key

Share a saved snapshot

View .md
POST

Create its share code, returned as shareCode. Anyone holding it, in any team, can start a sandbox from this disk with from, paying their own start and machine time; you keep paying for the snapshot. Calling again returns the same code until it is revoked.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • snapshotIdstringrequired

    Saved snapshot ID.

Responses

200Shared.
  • snapshotobjectrequired

    A sandbox's disk frozen under a name. $0.07 per started UTC day while you keep it, charged from your balance; the first day at save, refunded if the save fails. At most 20 per team.

    11 properties
    • idstringrequired
    • namestringrequired
    • statusstringrequired
      • saving: the disk is being captured. It cannot be started from or deleted yet.
      • ready: start sandboxes from it with from.
      • failed: the save did not finish; its first day was refunded. See failureReason.
      One ofsavingreadyfailed
    • sizestringrequired

      Machine size, and its price per hour of machine time: - small: 2 vCPU, 4 GB RAM. $0.0225/h. - default: 4 vCPU, 8 GB RAM. $0.045/h. - large: 8 vCPU, 16 GB RAM. $0.09/h.

      One ofsmalldefaultlarge
    • sizeBytesintegernullable

      Bytes on disk, once known.

    • sourceSandboxIdstringrequired

      The sandbox whose disk this is.

    • shareCodestringrequirednullable

      The code another team passes as from to start from this snapshot, while it is shared. Null when it is not. Treat it as a secret: whoever holds it can copy this disk.

    • costTotalnumberrequired

      USD charged for it so far.

    • failureReasonstringnullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Snapshot not found, or it belongs to another project.
  • codestringrequired
  • messagestringrequired
  • detailsobject
409`snapshot_not_ready`: only a ready snapshot can be shared.
  • codestringrequired
  • messagestringrequired
  • detailsobject