---
title: "POST /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot"
method: POST
path: "/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot"
tags: ["projects"]
---

# POST /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot

`POST /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot`

## Request

- Base URL: `https://dataflow.googleapis.com`
- URL: `https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot`
- Auth: one of:
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/cloud-platform`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/compute`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/compute`
- TypeScript: <https://skmtc.dev/google/apis/dataflow/docs/v1b3/projects/:projectId/locations/:location/jobs/:jobId:snapshot/post.ts> (a function with typed inputs; its response is checked against the schema)

Snapshot the state of a streaming job. # IAM Permissions Requires the `dataflow.jobs.snapshot` permission on the job.

## Path parameters

- `projectId` string, required
- `location` string, required
- `jobId` string, required

## Request body

- SnapshotJobRequest: Request to create a snapshot of a job.
  - `description` string: User specified description of the snapshot. Maybe empty.
  - `location` string: The location that contains this job.
  - `snapshotSources` boolean: If true, perform snapshots for sources which support this.
  - `ttl` string, google-duration: TTL for the snapshot.

## Response `200`

Successful response

- Snapshot: Represents a snapshot of a job.
  - `creationTime` string, google-datetime: The time this snapshot was created.
  - `description` string: User specified description of the snapshot. Maybe empty.
  - `diskSizeBytes` string, int64: The disk byte size of the snapshot. Only available for snapshots in READY state.
  - `id` string: The unique ID of this snapshot.
  - `projectId` string: The project this snapshot belongs to.
  - `pubsubMetadata` PubsubSnapshotMetadata[]: Pub/Sub snapshot metadata.
    - `expireTime` string, google-datetime: The expire time of the Pubsub snapshot.
    - `snapshotName` string: The name of the Pubsub snapshot.
    - `topicName` string: The name of the Pubsub topic.
  - `region` string: Cloud region where this snapshot lives in, e.g., "us-central1".
  - `sourceJobId` string: The job this snapshot was created from.
  - `state` 'UNKNOWN_SNAPSHOT_STATE' | 'PENDING' | 'RUNNING' | 'READY' | 'FAILED' | 'DELETED': State of the snapshot.
  - `ttl` string, google-duration: The time after which this snapshot will be automatically deleted.

## Changes

- **2026-10-21** `69a3fb1fef85`: 4 info
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2c`
- **2026-10-15** `e94d44227b2e`: 4 info
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2c`
- **2026-10-10** `9f491d01229e`: 2 breaking, 4 info
  - removed the request body
  - removed the media type `*/*` for the response with the status `200`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c`
  - …2 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/google/apis/dataflow/changes/v1b3/projects/:projectId/locations/:location/jobs/:jobId:snapshot/post.md)

---

[API](https://skmtc.dev/google/apis/dataflow.md) - [All operations](https://skmtc.dev/google/apis/dataflow/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/dataflow/revisions/8dcb888104b7?raw)