Eon snapshots API
Manage resource snapshots and point-in-time recovery points.
Eon snapshots API is one of 13 APIs that Eon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include snapshots. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 18 operations across 18 paths, and defines 74 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, /.
18 operations
18 paths
74 schemas
1 GET2 PATCH15 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Eon snapshots API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 18
Across 18 paths, the API surfaces 18 operations — 1 GET, 2 PATCH, 15 POST. Each is listed below with its method, path, parameters, and response codes.
snapshots 18
Manage resource snapshots and point-in-time recovery points.
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-files
Restore Files
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-bucket
Restore Bucket
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-bigquery-dataset
Restore BigQuery Dataset
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-ec2-ebs-volume
Restore EBS Volume
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/convert-ec2-ebs-snapshot
Restore to EBS Snapshot
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-rds-instance
Restore RDS Instance
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-ec2-instance
Restore EC2 Instance
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-dynamo-db-table
Restore DynamoDB Table
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-azure-vm-instance
Restore Azure VM Instance
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-azure-sql-database
Restore Azure SQL Database
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-azure-disk
Restore Azure Disk
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-gcp-disk
Restore GCP Disk
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-gcp-vm-instance
Restore GCP VM Instance
POST
/v1/projects/{projectId}/resources/{id}/snapshots/{snapshotId}/restore-gcp-cloudsql
Restore GCP Cloud SQL Instance
GET
/v1/projects/{projectId}/snapshots/{id}
Get Snapshot
PATCH
/v1/projects/{projectId}/snapshots/{id}/hold
Hold Snapshot
PATCH
/v1/projects/{projectId}/snapshots/{id}/remove-hold
Remove Snapshot Hold
POST
/v1/projects/{projectId}/resources/{id}/snapshots
List Resource Snapshots
Schemas 74
The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are Snapshot (11 properties), MPARequest (11 properties), GcpVmInstanceRestoreTarget (10 properties), AwsDatabaseDestination (9 properties). Each schema is shown below with its type and property counts.
SnapshotSortField
string
Field to sort by.
RestoreGcpDiskRequest
object
3 properties
3 required
RestoreDynamoDBTableRequest
object
2 properties
2 required
StorageAccountRestoreTarget
object
Information about the storage account where you want to restore the files. If you don't specify a target, the files are restored to the original storage accoun…
4 properties
2 required
VolumeSettings
object
Provisioned volume settings.
4 properties
2 required
EbsTarget
object
5 properties
3 required
SnapshotFilterConditions
object
1 property
ResourceSnapshot
object
Details about the backed-up resource at the time the snapshot was taken.
3 properties
AzureVmSnapshotProperties
object
Properties of the original Azure Virtual Machine instance at the time the snapshot was taken. Present only when resourceType is set to AZUREVIRTUALMACHINE.
3 properties
HoldSnapshotRequest
object
1 property
MPAInterceptedResponse
object
Body returned when an operation is intercepted by an MPA policy.
1 property
2 required
GcpDiskRestoreDestination
object
1 property
FilePath
object
2 properties
2 required
AzureDiskRestoreDestination
object
1 property
AzureSqlDatabaseRestoreTarget
object
5 properties
4 required
RdsPasswordConfig
object
Password management configuration for the restored RDS database.
3 properties
1 required
ListInventorySnapshotsResponse
object
3 properties
2 required
EbsRestoreDestination
object
1 property
AzureVmInstanceRestoreTarget
object
8 properties
5 required
SnapshotDateFilters
object
2 properties
RestoreAzureSqlDatabaseRequest
object
2 properties
2 required
RestoreGcpInstanceDiskInput
object
2 properties
2 required
EbsSnapshotTarget
object
4 properties
2 required
SortSnapshotsBy
object
List of sorting options. Sorting is applied in the order passed in the list.
2 properties
2 required
AwsEc2InstanceRestoreDestination
object
1 property
GetSnapshotResponse
object
1 property
1 required
MPAOperationType
string
Operation that requires action approval before it can be completed.
RestoreDbToRdsInstanceRequest
object
2 properties
2 required
ListInventorySnapshotsRequest
object
2 properties
GcpNetworkType
string
Network type. UNSPECIFIED is supported only in responses.
ResourceSnapshotProperties
object
Properties of the original resource at the time the snapshot was taken. The properties present in this object change depending on the value set in resourceType.
2 properties
AwsEc2SnapshotProperties
object
Properties of the original AWS EC2 instance at the time the snapshot was taken. Present only when resourceType is set to AWSEC2.
5 properties
AwsEc2InstanceRestoreTarget
object
8 properties
4 required
RestoreInstanceVolumeInput
object
5 properties
3 required
Error
object
1 property
MPARequestStatus
string
Lifecycle state of an action approval request from creation through resolution. DISCARDED means the requester abandoned a draft before it was submitted for app…
DynamodbTableRestoreDestination
object
1 property
AwsDynamoDBDestination
object
Configuration for restoring to DynamoDB.
5 properties
2 required
DatabaseDestination
object
Restore configuration.
1 property
Snapshot
object
Eon snapshot.
11 properties
4 required
AzureSqlDatabaseRestoreDestination
object
1 property
GcpDiskTarget
object
2 properties
2 required
AzureVmInstanceRestoreDestination
object
1 property
BigQueryDatasetDestination
object
Destination configuration for BigQuery dataset restore.
6 properties
1 required
MPARequestPolicyDetail
object
7 properties
5 required
RestoreVolumeToEbsRequest
object
3 properties
3 required
RestoreGcpCloudSqlRequest
object
2 properties
2 required
ResourceType
string
Resource type identifier combining cloud provider and service type. RESOURCETYPEUNSPECIFIED is supported only in responses.
AzureDiskSettings
object
6 properties
3 required
GcpVmInstanceRestoreDestination
object
1 property
MPARequest
object
11 properties
9 required
ObjectStorageDestination
object
3 properties
RestoreBigQueryDatasetRequest
object
2 properties
2 required
GcpVmInstanceRestoreTarget
object
10 properties
6 required
RestoreAwsEc2InstanceRequest
object
3 properties
2 required
RestoreAzureInstanceDiskInput
object
2 properties
2 required
RestoreAzureVmInstanceRequest
object
2 properties
2 required
GcpDiskSettings
object
8 properties
3 required
RestoreJobInitiationResponse
object
1 property
1 required
AzureDiskTarget
object
3 properties
3 required
InventorySnapshotVolume
object
5 properties
6 required
GCSRestoreTarget
object
Information about the Google Cloud Storage bucket where you want to restore the files. If you don't specify a target, the files are restored to the original bu…
2 properties
1 required
RestoreVolumeToEbsSnapshotRequest
object
3 properties
3 required
EbsSnapshotRestoreDestination
object
1 property
GcpCloudSqlTarget
object
6 properties
3 required
GcpCloudSqlRestoreDestination
object
1 property
S3RestoreTarget
object
Information about the S3 bucket where you want to restore the files. If you don't specify a target, the files are restored to the original bucket.
3 properties
1 required
AwsDatabaseDestination
object
Configuration for restoring to RDS.
9 properties
3 required
RestoreAzureDiskRequest
object
3 properties
3 required
RestoreFilesRequest
object
3 properties
3 required
RestoreGcpVmInstanceRequest
object
2 properties
2 required
AzureDisk
object
2 properties
2 required
SortOrder
string
Sort order. Use ASC for ascending order and DESC for descending order.
RestoreBucketRequest
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Eon 12
Other APIs Eon publishes across the network.
Eon accounts API
Eon actionApprovals API
Eon auth API
Eon backupPolicies API
Eon backups API
Eon billing API
Eon dashboard API
Eon databaseSnapshots API
Eon iam API
Eon jobs API
Eon resources API
Eon vaults API
#snapshots