How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

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

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
getTessellServices 14 params → 200default
POST
/services
Provision a DB service
provisionTessellService 1 param body → 200201default
GET
/services/{id}
Get a DB Service by Id
getTessellService 7 params → 200default
PATCH
/services/{id}
Update a DB service
updateTessellService 2 params body → 200201default
DELETE
/services/{id}
Delete a DB service
deleteTessellService 2 params body → 200201default
POST
/services/{id}/service-instances
Add DB service Instances
addTessellServiceInstances 2 params body → 200201default
DELETE
/services/{id}/service-instances
Delete DB service Instances
deleteTessellServiceInstances 2 params body → 200201default
PATCH
/services/{id}/start
Starts the DB Service
startTessellService 2 params body → 200201default
PATCH
/services/{id}/stop
Stops the DB Service
stopTessellService 2 params body → 200201default
PATCH
/services/{id}/resize
Resize DB service storage/compute
resizeDBService 2 params body → 200201default
PATCH
/services/{id}/connectivity
Update DB Service Connectivity
updateTessellServiceConnectivity 2 params body → 200201default
PATCH
/services/{id}/switchover
Switchover a DB Service
switchoverTessellService 2 params body → 200201default
POST
/services/{id}/restore
Restore a DB Service
restoreTessellService 2 params body → 200201default
PATCH
/services/{id}/patch-software
Patches the DB Service Software
patchSoftwareForTessellService 2 params body → 200201default
PATCH
/services/{service-id}/parameter-profiles
Update parameter profile/s for instances in service
updateDBServiceParameterProfiles 2 params body → 200default
PATCH
/services/{id}/integrations
Add/update an integration for the DB Service
updateTessellServiceIntegration 2 params body → 200201default
GET
/services/{id}/timeline
Get a DB timeline by service ID
getTessellServiceTimeline 2 params → 200default
DELETE
/services/{id}/cleanup-entry
Cleanup a failed DB service entry
cleanupFailedTessellServiceEntry 2 params → 200201default
POST
/availability-machines/{availability-machine-id}/clones
Clone a DB service
cloneTessellService 2 params body → 200201default
GET
/services/{id}/tags
View tags for the DB Service
getTessellServiceTags 2 params → 200default
PATCH
/services/{id}/tags
Create/update (override) tags for the DB Service
upsertTessellServiceTags 2 params body → 200201default
DELETE
/services/{id}/tags
Delete tags for a DB Service
deleteTessellServiceTags 2 params body → 200204default
GET
/services/eligible-pdb-clone-targets
Get list of services eligible as PDB clone targets
getEligiblePdbCloneTargets 8 params → 200default
PATCH
/services/{id}/timezone
Update DB service timezone
updateDbServiceTimezone 2 params body → 200201default
POST
/services/{service-id}/parameter-profiles/impact
Impact assessment for update parameter profile request
getDBServiceParameterProfileUpdateImpact 2 params body → 200default
POST
/parameter-profile/validate
validate the parameter profile.
validateParameterProfile 1 param body → 200default

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.

RestoreServicePayload
object
16 properties
OracleDatabaseConfig
objectnull
5 properties
AvailableUpdatesSimple
object
Simple boolean flags indicating available updates
2 properties
DatesForEachMonth
object
2 properties
TessellServiceMySqlEngineConfig
objectnull
3 properties
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
BackupType
string
Backup Content Type
DBServiceParameterProfileUpdateImpactResponse
object
1 property
MaintenanceWindowSummary
object
User view summary for Maintenance Window
5 properties
DeleteTessellServicePayload
object
3 properties
AssociatedActivities
object
3 properties
RefreshScheduleInfo
object
1 property
TessellServiceIntegrationsPayload
objectnull
Integrations to be enabled for the DB Service
1 property
PrivateLinkInfo
object
4 properties
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
SqlServerInstanceName
string
The named instance for SQL Server database (max 16 characters as per SQL Server limitation)
ApplyStrategy
string
PrivateLinkPayload
object
The interface endpoint or Gateway Load Balancer endpoint to connect to your DB service.
2 properties
MySqlEngineConfigPayload
object
3 properties 1 required
StopTessellServicePayload
InstanceStorageConfig
object
4 properties
ServiceInstanceEngineInfo
objectnull
This field details the DB Service Instance engine configuration details like - access mode
1 property
CloneTessellServicePayload
ComputeProviderType
string
MilvusIndexConfig
object
1 property
databaseEngineType
string
Database Engine Type
TessellServiceGenieStatus
string
DB Service's Genie status
TessellServiceTimelineResponse
TessellServiceInstanceRole
string
DB Service instance role
ScriptInfo
objectnull
4 properties
BackupCustomRpoPolicy
This is the definition of Custom RPO Policy for Backup for Tessell DB Service
ComputeConfigPayload
object
2 properties 1 required
CredentialsPayload
object
Payload for Credential details
2 properties 2 required
ValidateParameterProfilePayload
object
8 properties 4 required
DailySchedule
object
1 property
ExadataComputeConfigPayload
object
3 properties 2 required
OraclePdbConfig
object
5 properties
UpcomingMaintenanceWindowInfo
object
Information about the upcoming maintenance window
7 properties
WeeklySchedule
object
1 property
tessellServiceTopology
string
DB Service topology. This would specify whether the DB Service is single-node, or multi-node.
TessellServiceInstanceDTO
object
This is a definition of the DB Service Instance object
43 properties 1 required
TessellServiceConnectivityInfoPayload
object
DB Service connectivity details
5 properties 1 required
TimeFormat
object
Clock time format value in hour and minute.
2 properties 2 required
TaskDTO
object
User view for Task
15 properties
DatabaseStatus
string
ComputeConnectivityConfig
object
2 properties
UpdateTessellServicePayload
object
5 properties
MilvusDatatype
string
TaskStatus
string
The status of Task
RpoPolicyConfig
object
This is the definition for RPO Policy details for Tessell DB Service
7 properties 1 required
TessellServiceInstanceConnectString
object
4 properties
MaintenanceWindowStatus
string
The status of maintenance window
SwitchOverTessellServicePayload
object
3 properties 1 required
RestoreServiceConnectivityInfoPayload
object
DB Service connectivity details
2 properties 1 required
ProvisionServicePayload
object
28 properties 9 required
TessellServiceInstanceStatus
string
DB Service instance status
SecurityProfileSyncStatus
string
Sync status of the security profile applied on an instance/server
PatchDbServicePayload
object
4 properties 3 required
DeletionScheduleDTO
object
Details of the deletion schedule on a DB Service
3 properties 1 required
ServiceResizeConfig
SecurityProfileInfoOps
object
3 properties
CreateUpdateTessellTagPayload
object
Create or update Tessell tag Payload
1 property
UpdateDbServiceTimezonePayload
object
1 property 1 required
CloneSourceType
string
Source type for clone/refresh operation
ProvisionInfraPayload
object
The infra details where the DB Service is to be provisioned
17 properties 1 required
TessellUpdateDatabaseIntegrationDTO
object
3 properties
cloudType
string
Tessell supported cloud types
ServiceInstanceOracleEngineConfig
objectnull
1 property
TessellServiceStatus
string
The current status of the DB Service
DbCollectionIndexPayload
object
3 properties
PortAccessConfig
object
3 properties
AwsInfraConfig
object
1 property
CommonResizeConfig
object
4 properties
PatchActivity
object
6 properties
SecurityConfigPayload
object
1 property
OptionProfileStatus
string
Association status of the instance to the option profile
EntityTimelineDTO
object
This is a definition of the Entity Timeline object
9 properties
apiMetadata
object
3 properties
MilvusCreateCollectionConfig
objectnull
4 properties
InstanceComputeConfig
object
2 properties
TimeZone
string
The timezone detail
TessellServiceConnectString
object
DB Service connect string info
6 properties
MilvusIndexMetricType
string
TessellServiceOracleEngineConfig
objectnull
9 properties
TessellServiceEngineInfo
objectnull
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
InstanceResizeConfig
DBServiceInstanceParameterProfileUpdateRequest
object
3 properties
CreateOracleDatabaseConfig
objectnull
6 properties
StandardRpoPolicy
object
This is the definition of Standard RPO Policy for Snapshot for Tessell DB Service
3 properties 2 required
TessellServicePostgresqlEngineConfig
objectnull
5 properties
DbCollectionCreatePayload
object
2 properties
AzureNetAppConfigPayload
object
3 properties
ApacheKafkaEngineConfigPayload
object
1 property
RefreshScheduleRecurrenceInfo
object
3 properties 1 required
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
AddDbServiceInstancePayload
object
15 properties 1 required
MilvusIndexType
string
PatchType
string
Type of patch
EntityUserAclSharingInfo
object
Tessell Entity ACL Sharing Info for a user
4 properties
AzureNetAppEncryptionKeySource
MySqlDatabaseConfig
objectnull
2 properties
DBServiceParameterProfileUpdateRequest
object
2 properties
ProvisionComputePayload
object
15 properties
ServiceStorageConfig
object
2 properties
TaskOperation
string
The operation that the Task corresponds to
TessellServiceDTO
object
This is a definition of the DB Service object
43 properties
InstanceFsxNetAppConfig
object
5 properties
TessellTag
objectnull
2 properties
ServerPatchingConfig
object
Configuration for server patching with pre and post scripts
5 properties
TessellServiceMilvusEngineConfig
objectnull
1 property
RefreshServiceInfo
object
Service refresh details
7 properties
AzureNetAppEncryptionKeyInfo
object
Details of encryption key
4 properties
apiResponse
object
2 properties
TessellIntegrationRequestType
string
Request type enum for the addition/removal/updation of the Integration for the DB Service.
CreateUpdateRefreshSchedulePayload
object
4 properties
PerfInsightsStatus
string
Perf insights status of a Service Instance
AddDbServiceInstancePayloadV2
object
17 properties 4 required
RegionInfo
object
Cloud region details
2 properties 1 required
CustomRpoPolicy
object
This is the definition of Custom RPO Policy for Snapshot for Tessell DB Service
2 properties 2 required
MongodbDatabaseConfig
objectnull
1 property
SqlServerDatabaseConfig
objectnull
1 property
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
PostgresqlEngineConfigPayload
object
5 properties 1 required
InstanceAzureNetAppConfig
object
Service instance level Azure NetApp config
10 properties
InstanceAccessMode
string
Service instance access mode
InstanceSyncMode
string
Service instance sync mode
TessellServiceCredsPayload
object
DB Service's credential details
2 properties 2 required
tessellServiceLicenseType
string
DB Service License Type
InstanceExadataComputeConfig
object
6 properties 6 required
ParameterProfileStatus
string
Association status of the instance to the parameter profile
CreateDatabasePayload
object
5 properties
DBServiceCloneType
string
TessellServiceInstanceSubStatus
string
DB Service Instance could have a sub status associated along with status
OraclePdbConfigTaskPayload
object
6 properties
CloudRegionInfo
object
Cloud and region details
2 properties 1 required
ScheduleInfo
object
5 properties
SnapshotConfigurationPayload
MaintenanceCadence
string
Frequency of maintenance window
Month
string
Name of a month
apiStatus
object
2 properties
MilvusIndexParameters
object
4 properties
SecurityConfigOps
object
1 property
entityType
string
Tessell Entity Type
MongodbEngineConfigPayload
object
2 properties 2 required
TessellServiceDatabaseConnectString
object
4 properties
TessellServiceApacheKafkaEngineConfig
objectnull
1 property
TessellServiceEngineConfigurationPayload
object
13 properties
TessellServiceConnectivityInfo
object
DB Service's connectivity information
10 properties
StorageConfigPayload
object
The storage details to be provisioned.
3 properties 1 required
GcpInfraConfig
object
1 property
apiPaginationInfo
object
2 properties
TessellServiceSubStatus
string
DB Service could have a sub status associated along with status
taskSummary
object
5 properties
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
AutoPatchConfig
object
Configuration for automatic patching during maintenance windows
5 properties
SqlServerEngineConfigPayload
object
5 properties 1 required
PrePostScriptInfo
object
2 properties
MaintenanceWindowExecutionInfo
object
Execution details for Maintenance Window
3 properties
TaskType
string
The type of Task
PerfInsightsConfig
object
3 properties
PrivateLinkStatus
string
Tessell Private Link Status
ServiceUpdates
object
Update availability information for a DB Service
2 properties
IndexSpecification
object
3 properties
FullBackupSchedule
object
The schedule at which full backups would be triggered
2 properties
PostgresqlDatabaseConfig
objectnull
2 properties
MonitoringConfig
object
1 property
DeleteTagPayload
object
Delete Tessell tag Payload
1 property
FsxNetAppConfigPayload
object
The FSx NetApp details to be provisioned
2 properties 2 required
TessellServiceMongodbEngineConfig
objectnull
2 properties
TessellServiceContextInfo
object
Provide more context of DB Service state
2 properties
ResizeDBServiceRequest
object
3 properties
TaskResponse
object
5 properties
DBEngineCollationConfig
object
1 property
TessellServiceSqlServerEngineConfig
objectnull
5 properties
TessellServiceInstanceType
string
DB Service instance type
TaskResponseStatus
string
DbServicePrivateLinkStatus
string
DB Service's private link status
UpdateTessellServiceConnectivityPayload
object
1 property
OracleEngineConfigPayload
object
8 properties 3 required
DeleteTessellServiceInstancePayload
object
1 property 1 required
ConnectStringType
string
Connect string type
ServiceAzureNetAppConfig
object
1 property
MaintenanceWindowType
string
The type of maintenance window
TessellDatabaseDTO
object
12 properties
StorageProviderType
Storage Type in the cloud
MilvusEngineConfigPayload
object
1 property 1 required
MaintenanceWindowDTO
object
User view for Maintenance Window
11 properties
MilvusDatabaseConfig
objectnull
1 property
BackupStandardRpoPolicy
object
This is the definition of Standard RPO Policy for Backup for Tessell DB Service
2 properties 1 required
OptionProfile
object
4 properties
SqlServerRestoreServiceEngineConfigPayload
object
1 property
TessellServicesResponse
DatabaseConfiguration
objectnull
6 properties
MonthlySchedule
object
Definition for taking month specific schedule.
1 property
MilvusCreateCollectionField
object
10 properties
ApplyConfig
object
Application Details for any operation
4 properties
RefreshScheduleRefreshMode
ValidateParameterProfileInstanceResponse
object
3 properties
WeekDay
string
Week Days
EntityAclSharingInfo
object
Tessell Entity ACL Sharing Info
1 property
AddDbServiceInstancesPayload
object
10 properties 3 required
ApiError
object
Common error response object for non 2xx responses
7 properties
TessellServiceMaintenanceWindow
object
Base class for maintenance window configurations. Supports multiple cadences: Weekly, Monthly, and Quarterly. Use concrete subclasses: WeeklyMaintenanceWindow,…
3 properties 3 required
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
AzureNetAppCapacityPoolServiceLevel
string
MonthWiseDates
object
2 properties 2 required
TessellServiceConnectivityUpdateInProgressInfo
object
DB Service connectivity update-in-progress details
5 properties
ActionWithCommentPayload
object
1 property
commonYearlySchedule
YearlySchedule
object
2 properties
ServiceUpcomingScheduledActions
object
3 properties
ParameterProfile
object
4 properties
RestoreServiceEngineConfigurationPayload
object
1 property
StartTessellServicePayload
TessellResourceUpdateInfo
object
In progress update information for a Tessell Resource
4 properties
TaskResponseConflicts
object
1 property
ConnectStringUsageType
string
Usage type of connection string.
TessellServiceInstanceContextInfo
object
Provide more context of Service Instance state
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-db-service-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 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
Where this information came from

This is an independent, third-party profile of Tessell DB Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.