Skip to main content
POST
/
cloud
/
v1
/
lifecycle_policy
/
{project_id}
/
{region_id}
Create snapshot policy
curl --request POST \
  --url https://api.gcore.com/cloud/v1/lifecycle_policy/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "volume_snapshot",
  "name": "schedule_1",
  "schedules": [],
  "status": "active",
  "volume_ids": [
    "3ed9e2ce-f906-47fb-ba32-c25a3f63df4f"
  ]
}
'
{
  "action": "volume_snapshot",
  "id": 1,
  "name": "schedule_1",
  "project_id": 1,
  "region_id": 1,
  "schedules": [
    {
      "day": "5",
      "day_of_week": "mon,fri",
      "hour": "0, 20",
      "id": "1488e2ce-f906-47fb-ba32-c25a3f63df4f",
      "max_quantity": 2,
      "minute": "30",
      "month": "1,6",
      "owner": "lifecycle_policy",
      "owner_id": 1,
      "resource_name_template": "reserve snap of the volume {volume_id}",
      "retention_time": {
        "days": 0,
        "hours": 2,
        "minutes": 1,
        "weeks": 0
      },
      "timezone": "UTC",
      "type": "cron",
      "user_id": 12,
      "week": "1"
    }
  ],
  "status": "active",
  "user_id": 11,
  "volumes": [
    {
      "volume_id": "3ed9e2ce-f906-47fb-ba32-c25a3f63df4f",
      "volume_name": "test schedule"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

Examples:

1

​
region_id
integer
required

Region ID

Examples:

1

Body

application/json
​
action
enum<string>
required

Action that the policy will perform.

Available options:
volume_snapshot
​
name
string
required

Name of the lifecycle policy.

Examples:

"schedule_1"

​
schedules
Schedules · array

List of schedules associated with the policy.

Maximum length: 10
  • CreateCronScheduleSerializer
  • CreateIntervalScheduleSerializer
​
status
enum<string>

Current status of the lifecycle policy.

Available options:
active,
paused
​
volume_ids
string<uuid4>[]

List of volume IDs.

Examples:
["3ed9e2ce-f906-47fb-ba32-c25a3f63df4f"]

Response

200 - application/json

OK

​
action
string
required

Action associated with the lifecycle policy.

Examples:

"volume_snapshot"

​
id
integer
required

Unique identifier for the policy.

Examples:

1

​
name
string
required

Name of the policy.

Examples:

"schedule_1"

​
project_id
integer
required

Project ID associated with the policy.

Examples:

1

​
region_id
integer
required

Region ID where the policy is applied.

Examples:

1

​
schedules
Schedules · array
required

List of schedules within the policy.

  • GetCronScheduleSerializer
  • GetIntervalScheduleSerializer
​
status
enum<string>
required

Status of the lifecycle policy.

Available options:
active,
paused
​
user_id
integer
required

User ID of the creator of the policy.

Examples:

11

​
volumes
VolumeDataForLifecyclePolicySerializer · object[]
required

Data of volumes that should be reserved. Displayed only when the query parameter is specified.

Examples:
[
  {
    "volume_id": "3ed9e2ce-f906-47fb-ba32-c25a3f63df4f",
    "volume_name": "test schedule"
  }
]