Tessell Snapshot and Backup API
The Snapshot and Backup API from Tessell — 8 operation(s) for snapshot and backup.
Tessell Snapshot and Backup API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Snapshot and Backup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 14 operations across 8 paths, and defines 82 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, {server}.
14 operations
8 paths
82 schemas
3 DELETE7 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tessell Snapshot and Backup API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
Paths & Operations 14
Across 8 paths, the API surfaces 14 operations — 3 DELETE, 7 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Snapshot and Backup 14
GET
/availability-machines/{availabilityMachineId}/snapshots
Get list of snapshots for an Availability Machine
POST
/availability-machines/{availabilityMachineId}/snapshots
Submit a request to capture the associated DB Service's snapshot
GET
/availability-machines/{availabilityMachineId}/snapshots/{id}
Get details about the specified snapshot
DELETE
/availability-machines/{availabilityMachineId}/snapshots/{id}
Submit a request to delete the snapshot
POST
/availability-machines/{id}/backups/{backup-id}/download-url
Create download url for the backup
GET
/availability-machines/{id}/restore-info
Get the restore or clone information for the specified snapshot or the recovery-timestamp
GET
/availability-machines/{availabilityMachineId}/backups
View a list of available Tessell Backups
POST
/availability-machines/{availabilityMachineId}/backups
Create backup for the snapshot
GET
/availability-machines/{availabilityMachineId}/backups/{id}
get backup
DELETE
/availability-machines/{availabilityMachineId}/backups/{id}
Submit a request to delete the backup
GET
/availability-machines/{availabilityMachineId}/sanitized-snapshots
Get list of sanitized snapshots for an Availability Machine
POST
/availability-machines/{availabilityMachineId}/sanitized-snapshots
Submit a request to sanitize the specified snapshot
GET
/availability-machines/{availabilityMachineId}/sanitized-snapshots/{id}
Get details about the specified Sanitized Snapshot
DELETE
/availability-machines/{availabilityMachineId}/sanitized-snapshots/{id}
Submit a request to delete the Sanitized Snapshot
Schemas 82
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are DbBackupRestoreInfo (24 properties), TessellServiceInfrastructureInfo (21 properties), DatabaseBackup (17 properties), TessellServiceEngineInfo (13 properties). Each schema is shown below with its type and property counts.
apiStatus
object
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
commonYearlySchedule
AzureNetAppCapacityPoolServiceLevel
string
TessellServiceSqlServerEngineConfig
object
5 properties
CloudRegionInfoWithEncryption
object
Cloud and region details
2 properties
2 required
WeekDay
string
Week Days
BackupSource
string
Source from which the backup is derived
AwsInfraConfig
object
1 property
ScheduleInfo
object
5 properties
DatabaseBackupStatus
string
Database Backup Status
WeeklySchedule
object
1 property
CreateBackupTaskPayload
object
Payload to create a backup
5 properties
1 required
DatabaseSnapshotRegionInfo
object
Region availability details for a snapshot
2 properties
1 required
CreateSanitizedDatabaseSnapshotTaskPayload
object
Payload to create a sanitized snapshot
5 properties
3 required
ServiceAzureNetAppConfig
object
1 property
DatabaseSnapshotCloudRegionInfo
object
Cloud and region details
2 properties
1 required
SubscriptionCloudAvailability
object
2 properties
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
GetSanitizedDatabaseSnapshotsResponse
object
Information about the available Sanitized Snapshots
7 properties
AzureNetAppConfigPayload
object
3 properties
DbBackupRestoreInfo
object
24 properties
GetDatabaseBackupsResponse
object
Information about the available native-backups
8 properties
Month
string
Name of a month
TessellServiceEngineInfo
object
This field details the DB Service engine configuration details like - parameter profile, or options profile (if applicable) are used to configure the DB Servic…
13 properties
CreateDatabaseSnapshotTaskPayload
object
Payload to create an as-is snapshot for the DB Service
2 properties
1 required
EntityAclSharingSummaryInfo
object
Tessell Entity ACL Sharing Summary Info
1 property
TessellDataflixPitrInfo
object
Availability Machine's Point-In-Time recoverability information within a cloud
2 properties
cloudType
string
Tessell supported cloud types
OraclePdbConfigTaskPayload
object
6 properties
taskSummary
object
5 properties
TessellServiceOracleEngineConfig
object
9 properties
MonthlySchedule
object
Definition for taking month specific schedule.
1 property
DatabaseBackup
object
Information about the native backup
17 properties
GetDatabaseSnapshotsResponse
object
Information about the available snapshots
8 properties
ExpiryConfig
object
The backup expiry config
1 property
TessellServiceMilvusEngineConfig
object
1 property
CloudRegionInfo
object
Cloud and region details
2 properties
1 required
TessellServiceMySqlEngineConfig
object
3 properties
TessellDataflixFromTimeInfo
object
Availability Machine's Point-In-Time recoverability timeline
3 properties
BackupUserInfo
object
DB Service user info
3 properties
CustomRpoPolicy
object
This is the definition of Custom RPO Policy for Snapshot for Tessell DB Service
2 properties
2 required
databaseEngineType
string
Database Engine Type
BackupRestoreInfrastructureInfo
Tessell Service's infrastructure information
StorageConfigPayload
object
The storage details to be provisioned.
3 properties
1 required
DBEngineCollationConfig
object
1 property
BackupTargetType
string
Type of database entity being backed up
BackupStandardRpoPolicy
object
This is the definition of Standard RPO Policy for Backup for Tessell DB Service
2 properties
1 required
TessellServiceMongodbEngineConfig
object
2 properties
GcpInfraConfig
object
1 property
PreAuthUrlStatus
string
PreAuthUrl Status
CloneSourceType
string
Source type for clone/refresh operation
ServiceStorageConfig
object
2 properties
ComputeProviderType
string
BackupDatabaseInfo
object
The databases that are captured as part of the snapshot
5 properties
SnapshotRegionAvailability
object
2 properties
2 required
RpoPolicyConfig
object
This is the definition for RPO Policy details for Tessell DB Service
7 properties
1 required
TimeFormat
object
Clock time format value in hour and minute.
2 properties
2 required
SanitizedDatabaseSnapshot
object
Information about a Sanitized Snapshot
12 properties
FsxNetAppConfigPayload
object
The FSx NetApp details to be provisioned
2 properties
2 required
BackupCustomRpoPolicy
This is the definition of Custom RPO Policy for Backup for Tessell DB Service
StorageProviderType
Storage Type in the cloud
SqlServerInstanceName
string
The named instance for SQL Server database (max 16 characters as per SQL Server limitation)
StandardRpoPolicy
object
This is the definition of Standard RPO Policy for Snapshot for Tessell DB Service
3 properties
2 required
TessellServicePostgresqlEngineConfig
object
5 properties
DailySchedule
object
1 property
MonthWiseDates
object
2 properties
2 required
DatesForEachMonth
object
2 properties
RegionInfo
object
Cloud region details
2 properties
1 required
TessellServiceInfrastructureInfo
object
This field contains DB Service's infrastructure related information, like, where the service is hosted - cloud, region; what compute shape, or network is is co…
21 properties
SnapshotAvailabilityConfig
object
The snapshot availability config
3 properties
BackupType
string
Backup Content Type
ScriptInfo
object
4 properties
DatabaseSnapshot
object
Information about a snapshot
13 properties
TessellDataflixPitrInfoForRegion
object
Availability Machine's Point-In-Time recoverability information within a region
2 properties
RegionInfoWithEncryption
object
Cloud region details with encryption key
1 property
1 required
YearlySchedule
object
2 properties
BackupSourceInfo
object
Backup Source Info if the backup source is Snapshot
3 properties
SnapshotCloudAvailabilityInfo
object
Snapshot's cloud availability details
2 properties
1 required
TessellServiceApacheKafkaEngineConfig
object
1 property
FullBackupSchedule
object
The schedule at which full backups would be triggered
2 properties
TimeZone
string
The timezone detail
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tessell 12
Other APIs Tessell publishes across the network.
Tessell activity-center API
Tessell Ad Domain API
Tessell Ad Domain Governance API
Tessell agentController API
Tessell alert-controller API
Tessell Authorization API
Tessell Availability Machine API
Tessell azure-netapp-admin-controller API
Tessell azure-netapp-service-controller API
Tessell cloud-resource API
Tessell Compute API
Tessell Compute Governance API
#Snapshot and Backup