Tessell DB Service API
The DB Service API from Tessell — 20 operation(s) for db service.
Tessell DB Service API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include DB Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 26 operations across 20 paths, and defines 218 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, {server}.
26 operations
20 paths
218 schemas
4 DELETE5 GET11 PATCH6 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tessell DB Service API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
Paths & Operations 26
Across 20 paths, the API surfaces 26 operations — 4 DELETE, 5 GET, 11 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.
DB Service 26
GET
/services
View list of available DB Services
POST
/services
Provision a DB service
GET
/services/{id}
Get a DB Service by Id
PATCH
/services/{id}
Update a DB service
DELETE
/services/{id}
Delete a DB service
POST
/services/{id}/service-instances
Add DB service Instances
DELETE
/services/{id}/service-instances
Delete DB service Instances
PATCH
/services/{id}/start
Starts the DB Service
PATCH
/services/{id}/stop
Stops the DB Service
PATCH
/services/{id}/resize
Resize DB service storage/compute
PATCH
/services/{id}/connectivity
Update DB Service Connectivity
PATCH
/services/{id}/switchover
Switchover a DB Service
POST
/services/{id}/restore
Restore a DB Service
PATCH
/services/{id}/patch-software
Patches the DB Service Software
PATCH
/services/{service-id}/parameter-profiles
Update parameter profile/s for instances in service
PATCH
/services/{id}/integrations
Add/update an integration for the DB Service
GET
/services/{id}/timeline
Get a DB timeline by service ID
DELETE
/services/{id}/cleanup-entry
Cleanup a failed DB service entry
POST
/availability-machines/{availability-machine-id}/clones
Clone a DB service
GET
/services/{id}/tags
View tags for the DB Service
PATCH
/services/{id}/tags
Create/update (override) tags for the DB Service
DELETE
/services/{id}/tags
Delete tags for a DB Service
GET
/services/eligible-pdb-clone-targets
Get list of services eligible as PDB clone targets
PATCH
/services/{id}/timezone
Update DB service timezone
POST
/services/{service-id}/parameter-profiles/impact
Impact assessment for update parameter profile request
POST
/parameter-profile/validate
validate the parameter profile.
Schemas 218
The contract defines 218 schemas that model the data the API accepts and returns. The most detailed are TessellServiceInstanceDTO (43 properties), TessellServiceDTO (43 properties), ProvisionServicePayload (28 properties), TessellServiceInfrastructureInfo (21 properties). Each schema is shown below with its type and property counts.
OracleEngineConfigPayload
object
8 properties
3 required
TessellServiceInstanceRole
string
DB Service instance role
AddDbServiceInstancesPayload
object
10 properties
3 required
apiStatus
object
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
commonYearlySchedule
TessellServiceClonedFromInfo
object
If the DB Service is created as a clone from some other DB Service, this section describes the parent DB Service and cloning details
14 properties
TessellIntegrationRequestType
string
Request type enum for the addition/removal/updation of the Integration for the DB Service.
AzureNetAppCapacityPoolServiceLevel
string
apiResponse
object
2 properties
TessellServiceStatus
string
The current status of the DB Service
WeekDay
string
Week Days
EntityAclSharingInfo
object
Tessell Entity ACL Sharing Info
1 property
TessellServiceSqlServerEngineConfig
object
5 properties
ValidateParameterProfilePayload
object
8 properties
4 required
TessellServiceDatabaseConnectString
object
4 properties
TessellServiceTimelineResponse
AwsInfraConfig
object
1 property
PerfInsightsStatus
string
Perf insights status of a Service Instance
tessellServiceTopology
string
DB Service topology. This would specify whether the DB Service is single-node, or multi-node.
ScheduleInfo
object
5 properties
TaskResponse
object
5 properties
DatabaseConfiguration
object
6 properties
WeeklySchedule
object
1 property
RefreshScheduleRecurrenceInfo
object
3 properties
1 required
CredentialsPayload
object
Payload for Credential details
2 properties
2 required
TessellServiceConnectString
object
DB Service connect string info
6 properties
RefreshServiceInfo
object
Service refresh details
7 properties
MongodbDatabaseConfig
object
1 property
MaintenanceWindowType
string
The type of maintenance window
InstanceExadataComputeConfig
object
6 properties
6 required
PrePostScriptInfo
object
2 properties
ServiceAzureNetAppConfig
object
1 property
TessellServicesResponse
TessellResourceUpdateInfo
object
In progress update information for a Tessell Resource
4 properties
entityType
string
Tessell Entity Type
TessellServiceDeletionConfig
object
If the DB Service is to be deleted, this config would be honoured if no preference is provided during deleting the service
1 property
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
AzureNetAppEncryptionKeySource
ParameterProfile
object
4 properties
AzureNetAppConfigPayload
object
3 properties
UpdateDbServiceTimezonePayload
object
1 property
1 required
MaintenanceWindowExecutionInfo
object
Execution details for Maintenance Window
3 properties
DBServiceParameterProfileUpdateImpactResponse
object
1 property
RestoreServicePayload
object
16 properties
MaintenanceCadence
string
Frequency of maintenance window
EntityTimelineDTO
object
This is a definition of the Entity Timeline object
9 properties
DbServicePrivateLinkStatus
string
DB Service's private link status
Month
string
Name of a month
RestoreServiceEngineConfigurationPayload
object
1 property
SwitchOverTessellServicePayload
object
3 properties
1 required
CreateUpdateRefreshSchedulePayload
object
4 properties
InstanceAzureNetAppConfig
object
Service instance level Azure NetApp config
10 properties
TessellServiceIntegrationsInfo
object
Tessell provides support to integrate third party softwares with DB Services. This fields details the information about what third-party integrations are confi…
1 property
AddDbServiceInstancePayload
object
15 properties
1 required
TessellServiceInstanceContextInfo
object
Provide more context of Service Instance state
2 properties
UpdateTessellServiceConnectivityPayload
object
1 property
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
PatchType
string
Type of patch
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
InstanceAccessMode
string
Service instance access mode
PrivateLinkStatus
string
Tessell Private Link Status
TaskStatus
string
The status of Task
ApplyStrategy
string
TaskType
string
The type of Task
PostgresqlDatabaseConfig
object
2 properties
cloudType
string
Tessell supported cloud types
OraclePdbConfigTaskPayload
object
6 properties
DeleteTessellServiceInstancePayload
object
1 property
1 required
taskSummary
object
5 properties
TessellServiceIntegrationsPayload
object
Integrations to be enabled for the DB Service
1 property
TessellServiceOracleEngineConfig
object
9 properties
TessellServiceInstanceConnectString
object
4 properties
MilvusCreateCollectionConfig
object
4 properties
TessellServiceDTO
object
This is a definition of the DB Service object
43 properties
MonthlySchedule
object
Definition for taking month specific schedule.
1 property
PatchActivity
object
6 properties
TessellServiceConnectivityInfo
object
DB Service's connectivity information
10 properties
DeleteTessellServicePayload
object
3 properties
TessellUpdateDatabaseIntegrationDTO
object
3 properties
CreateUpdateTessellTagPayload
object
Create or update Tessell tag Payload
1 property
EntityUserAclSharingInfo
object
Tessell Entity ACL Sharing Info for a user
4 properties
PortAccessConfig
object
3 properties
TaskOperation
string
The operation that the Task corresponds to
TessellServiceConnectivityUpdateInProgressInfo
object
DB Service connectivity update-in-progress details
5 properties
CommonResizeConfig
object
4 properties
ProvisionServicePayload
object
28 properties
9 required
OptionProfile
object
4 properties
TessellServiceMilvusEngineConfig
object
1 property
MaintenanceWindowSummary
object
User view summary for Maintenance Window
5 properties
ExadataComputeConfigPayload
object
3 properties
2 required
TessellServiceInstanceStatus
string
DB Service instance status
InstanceResizeConfig
MaintenanceWindowDTO
object
User view for Maintenance Window
11 properties
CloudRegionInfo
object
Cloud and region details
2 properties
1 required
TessellServiceMySqlEngineConfig
object
3 properties
ActionWithCommentPayload
object
1 property
SecurityProfileSyncStatus
string
Sync status of the security profile applied on an instance/server
ServiceResizeConfig
DeleteTagPayload
object
Delete Tessell tag Payload
1 property
PostgresqlEngineConfigPayload
object
5 properties
1 required
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
ServerPatchingConfig
object
Configuration for server patching with pre and post scripts
5 properties
databaseEngineType
string
Database Engine Type
TaskDTO
object
User view for Task
15 properties
SecurityConfigPayload
object
1 property
ValidateParameterProfileInstanceResponse
object
3 properties
ApacheKafkaEngineConfigPayload
object
1 property
AutoPatchConfig
object
Configuration for automatic patching during maintenance windows
5 properties
ProvisionComputePayload
object
15 properties
MilvusCreateCollectionField
object
10 properties
RefreshScheduleRefreshMode
ServiceUpcomingScheduledActions
object
3 properties
TessellDatabaseDTO
object
12 properties
SqlServerRestoreServiceEngineConfigPayload
object
1 property
StorageConfigPayload
object
The storage details to be provisioned.
3 properties
1 required
MaintenanceWindowStatus
string
The status of maintenance window
DBEngineCollationConfig
object
1 property
TessellDatabaseClonedFromInfo
object
If a database is created as a clone from some other DB Service's database, this section describes the original database details
1 property
OracleDatabaseConfig
object
5 properties
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
IndexSpecification
object
3 properties
SqlServerDatabaseConfig
object
1 property
MilvusIndexConfig
object
1 property
TessellServiceMongodbEngineConfig
object
2 properties
TaskResponseStatus
string
GcpInfraConfig
object
1 property
UpdateTessellServicePayload
object
5 properties
RestoreServiceConnectivityInfoPayload
object
DB Service connectivity details
2 properties
1 required
MilvusIndexParameters
object
4 properties
ConnectStringUsageType
string
Usage type of connection string.
ResizeDBServiceRequest
object
3 properties
CloneSourceType
string
Source type for clone/refresh operation
ServiceStorageConfig
object
2 properties
ComputeProviderType
string
OraclePdbConfig
object
5 properties
DBServiceParameterProfileUpdateRequest
object
2 properties
MilvusIndexType
string
PatchDbServicePayload
object
4 properties
3 required
apiMetadata
object
3 properties
MySqlEngineConfigPayload
object
3 properties
1 required
TessellServiceSubStatus
string
DB Service could have a sub status associated along with status
UpcomingMaintenanceWindowInfo
object
Information about the upcoming maintenance window
7 properties
DatabaseStatus
string
TessellServiceEngineConfigurationPayload
object
13 properties
DbCollectionIndexPayload
object
3 properties
TessellServiceInstanceType
string
DB Service instance type
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
TessellServiceCredsPayload
object
DB Service's credential details
2 properties
2 required
TessellServiceConnectivityInfoPayload
object
DB Service connectivity details
5 properties
1 required
AddDbServiceInstancePayloadV2
object
17 properties
4 required
FsxNetAppConfigPayload
object
The FSx NetApp details to be provisioned
2 properties
2 required
ServiceUpdates
object
Update availability information for a DB Service
2 properties
MySqlDatabaseConfig
object
2 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
SqlServerInstanceName
string
The named instance for SQL Server database (max 16 characters as per SQL Server limitation)
ConnectStringType
string
Connect string type
MilvusIndexMetricType
string
PerfInsightsConfig
object
3 properties
TessellTag
object
2 properties
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
TessellServicePostgresqlEngineConfig
object
5 properties
DBServiceInstanceParameterProfileUpdateRequest
object
3 properties
SnapshotConfigurationPayload
MonthWiseDates
object
2 properties
2 required
TessellServiceContextInfo
object
Provide more context of DB Service state
2 properties
ProvisionInfraPayload
object
The infra details where the DB Service is to be provisioned
17 properties
1 required
DatesForEachMonth
object
2 properties
MilvusDatabaseConfig
object
1 property
RegionInfo
object
Cloud region details
2 properties
1 required
tessellServiceLicenseType
string
DB Service License Type
SqlServerEngineConfigPayload
object
5 properties
1 required
TessellServiceGenieStatus
string
DB Service's Genie status
MonitoringConfig
object
1 property
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
BackupType
string
Backup Content Type
TaskResponseConflicts
object
1 property
StopTessellServicePayload
ComputeConfigPayload
object
2 properties
1 required
MilvusEngineConfigPayload
object
1 property
1 required
SecurityConfigOps
object
1 property
InstanceSyncMode
string
Service instance sync mode
PrivateLinkInfo
object
4 properties
InstanceComputeConfig
object
2 properties
DbCollectionCreatePayload
object
2 properties
DBServiceCloneType
string
RefreshScheduleInfo
object
1 property
ScriptInfo
object
4 properties
ServiceInstanceEngineInfo
object
This field details the DB Service Instance engine configuration details like - access mode
1 property
SecurityProfileInfoOps
object
3 properties
TessellServiceMaintenanceWindow
object
Base class for maintenance window configurations. Supports multiple cadences: Weekly, Monthly, and Quarterly. Use concrete subclasses: WeeklyMaintenanceWindow,…
3 properties
3 required
ComputeConnectivityConfig
object
2 properties
TessellServiceInstanceSubStatus
string
DB Service Instance could have a sub status associated along with status
CloneTessellServicePayload
CreateOracleDatabaseConfig
object
6 properties
CreateDatabasePayload
object
5 properties
AssociatedActivities
object
3 properties
DeletionScheduleDTO
object
Details of the deletion schedule on a DB Service
3 properties
1 required
ApplyConfig
object
Application Details for any operation
4 properties
MongodbEngineConfigPayload
object
2 properties
2 required
YearlySchedule
object
2 properties
StartTessellServicePayload
AvailableUpdatesSimple
object
Simple boolean flags indicating available updates
2 properties
TessellServiceApacheKafkaEngineConfig
object
1 property
FullBackupSchedule
object
The schedule at which full backups would be triggered
2 properties
TimeZone
string
The timezone detail
MilvusDatatype
string
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
#DB Service