API Reference

Run prechecks for adding service instances to a DB service

post
https://{server}/services//service-instances/prechecks

Initiates cloud validation checks before adding service instances to 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…
Path Params
uuid
required
Body Params
string
length ≤ 10
string
required

The cloud-type in which the instance is to be provisioned (ex. aws, azure)

string
required

The region in which the instance is to be provisioned

string

The VPC to be used for provisioning the instance. If not specified, it will be inherited from the current instances that are in the same region. If no instances are present in the target region, this is a required input.

string

The compute-type to be used for provisioning the instance. If not specified, it will be inherited from the current primary instance.

boolean
Defaults to true

Specify whether to enable perf insights for the DB instances

awsInfraConfig
object
gcpInfraConfig
object
instances
array of objects
required
instances*
uuid | null

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

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