Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

RestoreSnapshot forks a new sandbox from a snapshot.

POST/v1/snapshots/{snapshot}/restore
RestoreSnapshot forks a new sandbox from a snapshot. Action: a restore creates a sandbox, so the snapshot in the path is the source and not the created resource.

Connection and access

API connection and authentication guidance

https://connect.docker.com/sandboxes — The API base URL. Append the /v1 paths while preserving this URL's path prefix.

Use one of these alternatives. Requirements within an alternative apply together.

  • bearer

Parameters

snapshot path Required

The snapshot id.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

Idempotency-Key header

Replay key. Reusing it with a different payload fails with failedPrecondition; accepted keys are retained for at least 24 hours.

Type: string

Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.
All schema constraints and annotations
{
  "description": "Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.",
  "title": "Idempotency-Key",
  "type": "string"
}

Request and responses

Request

application/json

Type: object

RestoreSnapshotRequest creates a new sandbox from one snapshot.
displayName

Type: string

(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.
All schema constraints and annotations
{
  "description": "(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.",
  "maxLength": 64,
  "pattern": "^[a-zA-Z0-9_-]*$",
  "type": "string"
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "RestoreSnapshotRequest creates a new sandbox from one snapshot.",
  "properties": {
    "displayName": {
      "description": "(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.",
      "maxLength": 64,
      "pattern": "^[a-zA-Z0-9_-]*$",
      "type": "string"
    }
  },
  "title": "RestoreSnapshotRequest",
  "type": "object"
}

Response 201

Success

application/json

Headers

ETag

The etag of the resource this response carries, which the next mutation of it sends as If-Match.

{
  "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
  "schema": {
    "type": "string"
  }
}
All constraints apply

Schema: Sandbox

All schema constraints and annotations
{
  "not": {
    "properties": {
      "core": {
        "properties": {
          "status": {
            "enum": [
              "creating",
              "starting"
            ]
          }
        },
        "required": [
          "status"
        ]
      }
    },
    "required": [
      "core"
    ]
  }
}
All schema constraints and annotations
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Sandbox"
    },
    {
      "not": {
        "properties": {
          "core": {
            "properties": {
              "status": {
                "enum": [
                  "creating",
                  "starting"
                ]
              }
            },
            "required": [
              "status"
            ]
          }
        },
        "required": [
          "core"
        ]
      }
    }
  ]
}

Response 202

Accepted. The resource is still progressing; read it or follow its events until completion.

application/json

Headers

ETag

The etag of the resource this response carries, which the next mutation of it sends as If-Match.

{
  "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
  "schema": {
    "type": "string"
  }
}
All constraints apply

Schema: Sandbox

core · required
status · required
All schema constraints and annotations
{
  "enum": [
    "creating",
    "starting"
  ]
}
All schema constraints and annotations
{
  "properties": {
    "status": {
      "enum": [
        "creating",
        "starting"
      ]
    }
  },
  "required": [
    "status"
  ]
}
All schema constraints and annotations
{
  "properties": {
    "core": {
      "properties": {
        "status": {
          "enum": [
            "creating",
            "starting"
          ]
        }
      },
      "required": [
        "status"
      ]
    }
  },
  "required": [
    "core"
  ]
}
All schema constraints and annotations
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Sandbox"
    },
    {
      "properties": {
        "core": {
          "properties": {
            "status": {
              "enum": [
                "creating",
                "starting"
              ]
            }
          },
          "required": [
            "status"
          ]
        }
      },
      "required": [
        "core"
      ]
    }
  ]
}

Response 409

Creation conflicts with an existing resource (ALREADY_EXISTS).

The Idempotency-Key was already used with a different payload.

application/json

Schema: Error

failedPrecondition

{
  "code": "failedPrecondition",
  "message": "The Idempotency-Key was already used with a different payload."
}

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/Error

#/components/schemas/Sandbox

Complete operation contract
{
  "description": "RestoreSnapshot forks a new sandbox from a snapshot.\nAction: a restore creates a sandbox, so the snapshot in the path is the source and not\nthe created resource.",
  "operationId": "restoreSnapshot",
  "parameters": [
    {
      "description": "The snapshot id.",
      "in": "path",
      "name": "snapshot",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Replay key. Reusing it with a different payload fails with failedPrecondition; accepted keys are retained for at least 24 hours.",
      "in": "header",
      "name": "Idempotency-Key",
      "schema": {
        "description": "Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.",
        "title": "Idempotency-Key",
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "additionalProperties": false,
          "description": "RestoreSnapshotRequest creates a new sandbox from one snapshot.",
          "properties": {
            "displayName": {
              "description": "(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.",
              "maxLength": 64,
              "pattern": "^[a-zA-Z0-9_-]*$",
              "type": "string"
            }
          },
          "title": "RestoreSnapshotRequest",
          "type": "object"
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Sandbox"
              },
              {
                "not": {
                  "properties": {
                    "core": {
                      "properties": {
                        "status": {
                          "enum": [
                            "creating",
                            "starting"
                          ]
                        }
                      },
                      "required": [
                        "status"
                      ]
                    }
                  },
                  "required": [
                    "core"
                  ]
                }
              }
            ]
          }
        }
      },
      "description": "Success",
      "headers": {
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "202": {
      "content": {
        "application/json": {
          "schema": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Sandbox"
              },
              {
                "properties": {
                  "core": {
                    "properties": {
                      "status": {
                        "enum": [
                          "creating",
                          "starting"
                        ]
                      }
                    },
                    "required": [
                      "status"
                    ]
                  }
                },
                "required": [
                  "core"
                ]
              }
            ]
          }
        }
      },
      "description": "Accepted. The resource is still progressing; read it or follow its events until completion.",
      "headers": {
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "409": {
      "content": {
        "application/json": {
          "examples": {
            "failedPrecondition": {
              "summary": "The Idempotency-Key was already used with a different payload.",
              "value": {
                "code": "failedPrecondition",
                "message": "The Idempotency-Key was already used with a different payload."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Creation conflicts with an existing resource (ALREADY_EXISTS).\n\nThe Idempotency-Key was already used with a different payload."
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "RestoreSnapshot forks a new sandbox from a snapshot.",
  "tags": [
    "Snapshots"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "FAILED_PRECONDITION",
      "description": "The Idempotency-Key was already used with a different payload."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "snapshotsRead",
    "sandboxesCreate"
  ],
  "x-sbx-resource-response": {
    "$ref": "#/components/schemas/Sandbox"
  },
  "x-sbx-serving-surface": "management"
}