API Reference

Run prechecks for provisioning a DB service

post
https://{server}/services/prechecks

Initiates cloud validation checks before provisioning a DB service. Returns a precheck ID that can be used to poll for status and retrieve the report.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

DB Service name

string

DB Service's description

string
required

Tessell Subscription in which the DB Service is to be created

string
string
enum
required

Database Engine Type

Allowed:
string
enum
required

DB Service topology. This would specify whether the DB Service is single-node, or multi-node.

Allowed:
int32
0 to 5
Defaults to 0

Number of instance (nodes) to be created for the DB Service. This is a required input for Apache Kafka. For all other engines, this input would be ignored even if specified.

string
required

Software Image to be used to create the DB Service

string
required

Software Image Version to be used to create the DB Service

boolean
Defaults to true

Specify whether to automatically update minor version for DB Service

boolean
Defaults to true

Specify whether to enable deletion protection for the DB Service

boolean
Defaults to false

Specify whether to enable stop protection for the DB Service

boolean
Defaults to true

Specify whether to enable perf insights for the DB Service

infrastructure
object

The infra details where the DB Service is to be provisioned

instances
array of objects

The instances (nodes) for this DB Service

instances
serviceConnectivity
object
required

DB Service connectivity details

creds
object
required

DB Service's credential details

maintenanceWindow
object

Base class for maintenance window configurations. Supports multiple cadences: Weekly, Monthly, and Quarterly. Use concrete subclasses: WeeklyMaintenanceWindow, MonthlyMaintenanceWindow, QuarterlyMaintenanceWindow.

autoPatchConfig
object

Configuration for automatic OS and DB patching during maintenance windows

serverPatchingConfig
object

Configuration for server patching with pre and post scripts

deletionConfig
object

If the DB Service is to be deleted, this config would be honoured if no preference is provided during deleting the service

snapshotConfiguration
object

Deprecated: This property is deprecated and will be removed in future versions. Please use rpoPolicyConfig instead. Defines the snapshot retention configurations for the DB Service. If not specified, the default recommended retention configurations will be applied.

rpoPolicyConfig
object

This is the definition for RPO Policy details for Tessell DB Service

engineConfiguration
object
required
databases
array of objects

Specify the databases to be created in the DB Service

databases
integrationsConfig
object | null

Integrations to be enabled for the DB Service

tags
array of objects

The tags to be associated with the DB Service

tags
uuid | null

The precheck ID from a previously run precheck validation. If provided, the system will verify the precheck results before provisioning.

Headers
string
required

Authorization Token

Responses

Updated about 3 hours ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago