Create Restore Template

POST

https://{account-domain}.console.eon.io/api/v1/projects/:projectId/inventory/restore-templates

POST

/api/v1/projects/:projectId/inventory/restore-templates

curl -X POST https://{account-domain}.console.eon.io/api/v1/projects/733888d8-2573-5f9a-b81d-21f051d24fda/inventory/restore-templates \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "EC2 production restore template",
  "resourceType": "EC2_INSTANCE"
}'

201Created

{
  "restoreTemplate": {
    "id": "de308488-df3d-5b82-8f37-477ef529f491",
    "name": "EC2 production restore template",
    "resourceType": "EC2_INSTANCE",
    "description": "Used for restoring production EC2 instances",
    "ec2Params": {
      "subnetId": "subnet-0123456789abcdef0",
      "keepOriginalTags": true,
      "nameTemplate": "{original_name}-restored",
      "startAfterRestore": false,
      "targetAccountId": "9b76a8a2-a918-57e6-94d5-0316ebab663c",
      "targetRegion": "us-east-1",
      "securityGroupIds": [
        "sg-0123456789abcdef0"
      ],
      "instanceType": "t3.medium",
      "inheritInstanceType": false,
      "kmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/mrk-abc123",
      "additionalTags": [
        {
          "key": "eon_api_restore",
          "value": "true"
        }
      ]
    },
    "s3Params": {
      "targetBucketId": "my-restore-bucket",
      "prefixTemplate": "restored/{original_prefix}",
      "targetAccountId": "9b76a8a2-a918-57e6-94d5-0316ebab663c",
      "targetRegion": "us-east-1",
      "kmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/mrk-abc123"
    },
    "attachedResourceCount": 3,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-16T14:20:00Z"
  }
}

Creates a restore template.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"

ID of the project the restore template is in. You can get your project ID from the API Credentials page in your global management console.

Request

This endpoint expects an object.

namestringRequired

Restore template display name.

resourceTypeenumRequired

Resource type the restore template applies to. RESTORE_TEMPLATE_RESOURCE_TYPE_UNSPECIFIED is supported only in responses.

Allowed values:

descriptionstringOptional

Description of the purpose of the restore template.

ec2ParamsobjectOptional

s3ParamsobjectOptional

Response

Restore template created.

restoreTemplateobject

Created restore template.