---
title: "Get snapshot schedule for an instance"
method: GET
path: "/instances/{id}/snapshot-schedule"
---

# Get snapshot schedule for an instance

`GET /instances/{id}/snapshot-schedule`

## Path parameters

- `id` string, required

## Response `200`

Snapshot schedule

- SnapshotSchedule
  - `instance_id` string, required — Source instance ID.
  - `interval` string, required — Snapshot interval (Go duration format).
  - `name_prefix` string, nullable — Optional prefix used for generated scheduled snapshot names.
  - `metadata` Tags — User-defined key-value tags.
  - `retention` SnapshotScheduleRetention, required — Automatic cleanup policy for scheduled snapshots.
    - `max_count` integer — Keep at most this many scheduled snapshots for the instance (0 disables count-based cleanup).
    - `max_age` string — Delete scheduled snapshots older than this duration (Go duration format).
  - `next_run_at` string, date-time, required — Next scheduled run time.
  - `last_run_at` string, date-time, nullable — Last schedule execution time.
  - `last_snapshot_id` string, nullable — Snapshot ID produced by the last successful run.
  - `last_error` string, nullable — Last schedule run error, if any.
  - `created_at` string, date-time, required — Schedule creation timestamp.
  - `updated_at` string, date-time, required — Schedule update timestamp.

## Other responses

- `404` — Snapshot schedule not found
- `500` — Internal server error

---

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