ec2.snapshot-policies.createSnapshot instances on a schedule and keep the newest N per instance
Targets are instance ids, tags, or both; at least one is required. A snapshot of a running instance is crash-consistent, like an EBS snapshot.
Request syntax
POST /ec2/api/snapshot-policies
{
"name": "string",
"description": "string",
"enabled": "boolean",
"targetInstanceIds": "array of string",
"targetTags": "map of string",
"intervalHours": "number",
"startTime": "string",
"retainCount": "number",
"regionId": "string"
}Request body
nameRequiredstring
A display name
Constraints: 1-64 chars
descriptionOptionalstring
Free text; null clears it
Constraints: max 255 chars
May be null.
enabledOptionalboolean
A paused policy takes nothing and keeps its images
targetInstanceIdsOptionalarray of string
Instances to snapshot (i-…)
Constraints: /^i-[0-9a-f]{6,32}$/
targetTagsOptionalmap of string
Also snapshot every instance that carries all of these tags
Constraints: key=value
intervalHoursRequirednumber
Hours between runs: 1, 2, 3, 4, 6, 8, 12, 24 or 168 (weekly, on Mondays)
Constraints: integer
startTimeRequiredstring
HH:MM UTC; runs fall on this time plus whole intervals
Constraints: /^([01]\d|2[0-3]):[0-5]\d$/
retainCountRequirednumber
Images kept per instance; older ones this policy took are deregistered
Constraints: integer, 1-100
regionIdRequiredstring
The region the policy belongs to, e.g. de1
Constraints: 1-32 chars
Response
201: `data` is the new policy (fields as listed), with `nextRunAt` its first run.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow ec2:CreateSnapshotPolicy on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud ec2 snapshot-policies create --name example --interval-hours 1 --start-time example --retain-count 1 --region-id examplecurl -X POST "https://console.platform-development.deutschecloud.app/ec2/api/snapshot-policies" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"example","intervalHours":1,"startTime":"example","retainCount":1,"regionId":"example"}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_snapshot-policies_create.