---
title: "POST /v1/{+name}:snapshot"
method: POST
path: "/v1/{+name}:snapshot"
tags: ["projects"]
---

# POST /v1/{+name}:snapshot

`POST /v1/{+name}:snapshot`

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

## Path parameters

- `name` string, required

## Request body

- GoogleCloudAiplatformV1SandboxEnvironmentSnapshot — SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
  - `name` string — Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
  - `createTime` string, google-datetime — Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
  - `displayName` string — Required. The display name of the SandboxEnvironmentSnapshot.
  - `owner` string — Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
  - `ttl` string, google-duration — Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
  - `parentSnapshot` string — Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
  - `updateTime` string, google-datetime — Output only. The timestamp when this SandboxEnvironment was most recently updated.
  - `sizeBytes` string, int64 — Optional. Output only. Size of the snapshot data in bytes.
  - `sourceSandboxEnvironment` string — Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
  - `expireTime` string, google-datetime — Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
  - `postSnapshotAction` 'POST_SNAPSHOT_ACTION_UNSPECIFIED' | 'RUNNING' | 'PAUSE' — Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/aiplatform.md) · [All operations](https://skmtc.net/google/apis/aiplatform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/aiplatform/versions/b608d71b91f0/schema)