Project / Services /

Create container snapshot

Schedules a snapshot of a running deployment service pod. When no pod is provided, the service must have exactly one eligible pod. Repeated requests for an active pod return the existing snapshot.

Required permission

Account > Platform > ContainerSnapshots > Create

Path parameters

projectId
string required
ID of the project
serviceId
string required
ID of the service

Request body

{object}

podName
string
The running service pod to snapshot.

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
trigger
string required
one of
manual, containerTermination
state
string required
one of
scheduled, accepted, running, succeeded, failed, cancelled
source
{object} required

projectId
string required
nfObject
{object} required

id
string required
type
string required
one of
job, service, harness, addon, volume, opentofu-job, llm-model-deployment, external-addon

target
{object} required

podName
string required

compatibility
{object} required

runtime
string required
one of
kata
architecture
string required
one of
x86, arm
baseImageDigest
string
pattern
^sha256:[0-9a-f]{64}$

parentSnapshotId
string
inUse
boolean required
result
{object}

sizeBytes
integer required

error
{object}

code
string required
message
string required
retryable
boolean required

requestedAt
string
deadline
string
lastTransitionTime
string required
startedAt
string
completedAt
string
createdAt
string required
updatedAt
string required

API

CLI

JS Client

POST /v1/projects/{projectId}/services/{serviceId}/snapshots

POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/snapshots

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data 'undefined' \
  https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/snapshots

Example response

202 Accepted

The scheduled container snapshot.

JSON

Example response

409 Conflict

No eligible pod exists, or multiple eligible pods require explicit selection.