Pipeline Operations

Create a one-time snapshot for a pipeline by pipeline id

post/pipelines/{id}/snapshots

Request

Base URL
https://replace-with-account.api.decodable.co/v1alpha2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
  Token URLhttps://auth.decodable.co/oauth/token
  Scopeswrite:pipeline
TypeScript
https://skmtc.dev/decodable/apis/decodable-control-plane/docs/pipelines/:id/snapshots/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring

The name of the snapshot.

retention_period_secondsnumber

A retention period for the created snapshots, in seconds.

A single snapshot.

idstring

An identifier for the snapshot

job_idstring

The id of the pipeline or connection that initially created the snapshot.

namestring

The name of the snapshot.

type'SCHEDULED' | 'ONE_TIME'

The scheduling type of the snapshot.

start_timestring date-time

The date and time the snapshot was started.

end_timestring date-time

The date and time the snapshot was completed.

retention_timestring date-time

The date and time the snapshot will be retained until.

The current state of the snapshot.

No recorded changes to this operation across all 1 revision of this API.