Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tessell Availability Machine API

The Availability Machine API from Tessell — 10 operation(s) for availability machine.

Tessell Availability Machine API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Availability Machine. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 13 operations across 10 paths, and defines 99 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, {server}.

13 operations 10 paths 99 schemas 2 DELETE7 GET4 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.console.tessell.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Tessell Availability Machine API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 2 DELETE, 7 GET, 4 PATCH. Each is listed below with its method, path, parameters, and response codes.

Availability Machine 13
GET
/availability-machines
Get a list of Availability Machines
getAvailabilityMachines 12 params → 200default
GET
/availability-machines/{id}
Get details about an Availability Machine
getAvailabilityMachine 8 params → 200default
DELETE
/availability-machines/{id}
Delete the Availability Machine and the associated data (if any) including snapshots, sanitized-snapshots, and backups.
deleteAvailabilityMachine 2 params → 200default
PATCH
/availability-machines/{id}/pause
Pause the automated backups for a Availability Machine
pauseAvailabilityMachine 2 params body → 200default
PATCH
/availability-machines/{id}/backup-download-config
Allow backup download for a Availability Machine
updateBackupDownloadConfig 2 params body → 200default
PATCH
/availability-machines/{id}/resume
Resume the automated backups for a Availability Machine
resumeAvailabilityMachine 2 params body → 200default
GET
/availability-machines/{id}/acls
Get list of ACLs for an Availability Machine
getAvailabilityMachineAcls 2 params → 200default
PATCH
/availability-machines/{id}/acls
Create or update ACLs for an Availability Machine
createAvailabilityMachineAcls 2 params body → 200204default
DELETE
/availability-machines/{id}/acls
Revoke ACLs for an Availability Machine
revokeAvailabilityMachineAcls 2 params body → 200default
GET
/availability-machines/{id}/acls/eligible-users
Get list of users which are eligible to grant access for an Availability Machine
getEligibleUsersForAvailabilityMachine 3 params → 200default
GET
/dataflix/{id}/catalog/backups/{backup-id}/download-url
Get download url info for the backup
getDownloadUrlInfo 3 params → 200default
GET
/dataflix/{id}/acls/eligible-users
Get list of all the users by privileges
getEligibleUsersForDataflix 3 params → 200default
GET
/availability-machines/{id}/size
Get size consumption details for Tessell Data Management Machine
getAvailabilityMachineSize 3 params → 200default

Schemas 99

The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are TessellServiceInstanceDTO (43 properties), DmmConsumerView (21 properties), TessellDapServiceDTO (15 properties), DataflixDownloadUrlInfo (10 properties). Each schema is shown below with its type and property counts.

TessellServiceInstanceRole
string
DB Service instance role
SubscriptionsCloudLocationsAndKey
object
The cloud location information along with encryption key where the data is being managed by this Access Policy
3 properties 2 required
apiStatus
object
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
commonYearlySchedule
AzureNetAppCapacityPoolServiceLevel
string
EntityAclSharingInfo
object
Tessell Entity ACL Sharing Info
1 property
WeekDay
string
Week Days
AwsInfraConfig
object
1 property
PerfInsightsStatus
string
Perf insights status of a Service Instance
ScheduleInfo
object
5 properties
DapStatus
string
Database Access Policy Status
WeeklySchedule
object
1 property
InstanceExadataComputeConfig
object
6 properties 6 required
TessellResourceUpdateInfo
object
In progress update information for a Tessell Resource
4 properties
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
AzureNetAppEncryptionKeySource
AmDataIngestionStatus
string
Availability Machine's data ingestion status
ParameterProfile
object
4 properties
PauseTessellDmmPayload
object
This is a definition for pausing a Tessell Data Management Machine
1 property
AzureNetAppConfigPayload
object
3 properties
AsIsDapContent
object
2 properties
Month
string
Name of a month
InstanceAzureNetAppConfig
object
Service instance level Azure NetApp config
10 properties
TessellServiceInstanceContextInfo
object
Provide more context of Service Instance state
2 properties
TessellServiceInstanceDTO
object
This is a definition of the DB Service Instance object
43 properties 1 required
PrivateLinkPayload
object
The interface endpoint or Gateway Load Balancer endpoint to connect to your DB service.
2 properties
RegionToEncryptionKey
object
2 properties 1 required
InstanceAccessMode
string
Service instance access mode
PrivateLinkStatus
string
Tessell Private Link Status
cloudType
string
Tessell supported cloud types
DmmSizeInfoDTO
object
3 properties
TessellServiceInstanceConnectString
object
4 properties
DapManualInfo
object
4 properties
MonthlySchedule
object
Definition for taking month specific schedule.
1 property
EntityUserAclSharingInfo
object
Tessell Entity ACL Sharing Info for a user
4 properties
OptionProfile
object
4 properties
ExpiryConfig
object
The backup expiry config
1 property
TessellServiceInstanceStatus
string
DB Service instance status
TessellApiResponse
object
2 properties
CloudRegionInfo
object
Cloud and region details
2 properties 1 required
SecurityProfileSyncStatus
string
Sync status of the security profile applied on an instance/server
DapContentInfo
object
3 properties
AzureNetAppEncryptionKeyInfo
object
Details of encryption key
4 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
StorageConfigPayload
object
The storage details to be provisioned.
3 properties 1 required
AclRevokePayload
object
Payload to revoke Tessell ACLs
1 property 1 required
ParameterProfileStatus
string
Association status of the instance to the parameter profile
apiPaginationInfo
object
2 properties
BackupStandardRpoPolicy
object
This is the definition of Standard RPO Policy for Backup for Tessell DB Service
2 properties 1 required
AclPayload
object
Payload to create an entity ACL
1 property 1 required
DmmConsumerView
object
The Availability Machine is an abstraction provided by Tessell that takes care of all of the data-management and data-protection aspects for a DB Service, like…
21 properties
GcpInfraConfig
object
1 property
TessellCloneSummaryInfo
object
This is a definition for Database Clone's summary
10 properties 1 required
UpdateBackupDownloadConfigPayload
object
This is a definition for updating backup download config.
2 properties
PreAuthUrlStatus
string
PreAuthUrl Status
DapRetentionInfo
object
2 properties
DBServiceTopology
object
4 properties
SanitizationDapContent
object
2 properties
ResumeTessellDmmPayload
object
This is a definition for resuming a Tessell Data Management Machine
1 property
ComputeProviderType
string
AclUserPayload
object
Payload to create an user's entity ACL
2 properties 2 required
apiMetadata
object
3 properties
BackupDapContent
object
2 properties
TessellServiceInstanceType
string
DB Service instance type
TessellDmmSizeDTO
object
6 properties
RpoPolicyConfig
object
This is the definition for RPO Policy details for Tessell DB Service
7 properties 1 required
InstanceFsxNetAppConfig
object
5 properties
OptionProfileStatus
string
Association status of the instance to the option profile
TimeFormat
object
Clock time format value in hour and minute.
2 properties 2 required
GetDmmsServiceView
FsxNetAppConfigPayload
object
The FSx NetApp details to be provisioned
2 properties 2 required
TessellDapServiceDTO
object
Access Policy (DAP) and the associated configuration
15 properties
AclEligibleUser
object
Eligible user for sharing the entity
5 properties
BackupCustomRpoPolicy
This is the definition of Custom RPO Policy for Backup for Tessell DB Service
StorageProviderType
Storage Type in the cloud
ServiceInstanceOracleEngineConfig
object
1 property
DbBackupStatus
string
DB Backup Status
PerfInsightsConfig
object
3 properties
DapContentType
string
Content Type for the Data Access Policy
StandardRpoPolicy
object
This is the definition of Standard RPO Policy for Snapshot for Tessell DB Service
3 properties 2 required
DailySchedule
object
1 property
InstanceStorageConfig
object
4 properties
MonthWiseDates
object
2 properties 2 required
DatesForEachMonth
object
2 properties
BackupDownloadConfig
object
This is a definition for backup download config
2 properties
RegionInfo
object
Cloud region details
2 properties 1 required
MonitoringConfig
object
1 property
SecurityConfigOps
object
1 property
InstanceSyncMode
string
Service instance sync mode
PrivateLinkInfo
object
4 properties
InstanceComputeConfig
object
2 properties
ServiceInstanceEngineInfo
object
This field details the DB Service Instance engine configuration details like - access mode
1 property
SecurityProfileInfoOps
object
3 properties
DataflixDownloadUrlInfo
object
Tessell Backup's Dataflix view
10 properties
TessellServiceInstanceSubStatus
string
DB Service Instance could have a sub status associated along with status
YearlySchedule
object
2 properties
FullBackupSchedule
object
The schedule at which full backups would be triggered
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-availability-machine-api-openapi.yml Raw ↑

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 azure-netapp-admin-controller API
Tessell azure-netapp-service-controller API
Tessell cloud-resource API
Tessell Compute API
Tessell Compute Governance API
Tessell Compute Resource API