The tessell-service-precheck-controller API from Tessell — 6 operation(s) for tessell-service-precheck-controller.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/tessell-tessell-service-precheck-controller-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Tessell APIs activity-center Tessell Service Precheck Controller API
contact:
email: support@tessell.com
name: Tessell Inc
url: https://www.tessell.com
description: Tessell API Documentation
termsOfService: https://www.tessell.com/terms
version: '1.0'
servers:
- url: '{server}'
variables:
server:
default: console.tessell.com
tags:
- name: tessell-service-precheck-controller
paths:
/services/prechecks:
post:
tags:
- tessell-service-precheck-controller
summary: Run prechecks for provisioning a DB service
description: 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.
operationId: runPrechecksForProvision
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionServicePayload'
responses:
'202':
description: Accepted - Prechecks initiated
content:
application/json:
schema:
$ref: '#/components/schemas/PrecheckStatusResponse'
default:
description: API error response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
parameters:
- name: Authorization
in: header
description: Authorization Token
required: true
style: simple
schema:
type: string
/services/prechecks/{id}/status:
get:
tags:
- tessell-service-precheck-controller
summary: Get precheck status
description: Returns the current status of a precheck request
operationId: getPrecheckStatus
parameters:
- $ref: '#/components/parameters/id'
- name: Authorization
in: header
description: Authorization Token
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PrecheckStatusResponse'
default:
description: API error response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/services/prechecks/{id}/report:
get:
tags:
- tessell-service-precheck-controller
summary: Get precheck report
description: Returns the detailed precheck report with individual check results
operationId: getPrecheckReport
parameters:
- $ref: '#/components/parameters/id'
- name: Authorization
in: header
description: Authorization Token
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PrecheckReportResponse'
default:
description: API error response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/services/{service-id}/service-instances/prechecks:
post:
tags:
- tessell-service-precheck-controller
summary: Run prechecks for adding service instances to a DB service
description: 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.
operationId: runPrechecksForServiceInstances
parameters:
- $ref: '#/components/parameters/service-id'
- name: Authorization
in: header
description: Authorization Token
required: true
style: simple
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddDbServiceInstancesPayload'
responses:
'202':
description: Accepted - Prechecks initiated
content:
application/json:
schema:
$ref: '#/components/schemas/PrecheckStatusResponse'
default:
description: API error response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/services/{service-id}/resize/prechecks:
post:
tags:
- tessell-service-precheck-controller
summary: Run prechecks for resizing a DB service
description: Initiates cloud validation checks before resizing a DB service. Returns a precheck ID that can be used to poll for status and retrieve the report.
operationId: runPrechecksForResize
parameters:
- $ref: '#/components/parameters/service-id'
- name: Authorization
in: header
description: Authorization Token
required: true
style: simple
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ResizeDBServiceRequest'
responses:
'202':
description: Accepted - Prechecks initiated
content:
application/json:
schema:
$ref: '#/components/schemas/PrecheckStatusResponse'
default:
description: API error response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/availability-machines/{availability-machine-id}/clones/prechecks:
post:
tags:
- tessell-service-precheck-controller
summary: Run prechecks for cloning a DB service
description: Initiates cloud validation checks before cloning a DB service. Returns a precheck ID that can be used to poll for status and retrieve the report.
operationId: runPrechecksForClone
parameters:
- name: availability-machine-id
in: path
description: The Id of the Availability Machine
required: true
style: simple
schema:
type: string
format: uuid
- name: Authorization
in: header
description: Authorization Token
required: true
style: simple
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CloneTessellServicePayload'
responses:
'202':
description: Accepted - Prechecks initiated
content:
application/json:
schema:
$ref: '#/components/schemas/PrecheckStatusResponse'
default:
description: API error response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
PrecheckItem:
type: object
description: Individual precheck item for user-facing report
properties:
name:
type: string
description: Name of the precheck
status:
$ref: '#/components/schemas/PrecheckStatus'
message:
type: string
description: Message describing the check result
resolution:
type: string
description: Suggested resolution if the check failed
expiredAt:
type: string
format: date-time
description: Timestamp when the check result expires
instanceId:
type: string
description: Instance ID of the node where the precheck is run
DatesForEachMonth:
type: object
properties:
dates:
description: Dates in a month to retain monthly backups
uniqueItems: true
type: array
items:
type: integer
format: int32
minimum: 1
maximum: 31
lastDayOfMonth:
type: boolean
default: false
BackupType:
description: Backup Content Type
type: string
enum:
- AS_IS
- SANITIZED
RefreshScheduleInfo:
type: object
properties:
recurring:
$ref: '#/components/schemas/RefreshScheduleRecurrenceInfo'
TessellServiceIntegrationsPayload:
title: TessellServiceIntegrationsPayload
description: Integrations to be enabled for the DB Service
type:
- object
- 'null'
x-patchable: true
properties:
integrations:
type:
- array
- 'null'
items:
type: string
format: uuid
SqlServerInstanceName:
type: string
maxLength: 16
description: The named instance for SQL Server database (max 16 characters as per SQL Server limitation)
MySqlEngineConfigPayload:
title: MySqlEngineConfigPayload
type: object
required:
- parameterProfileId
properties:
parameterProfileId:
type: string
format: uuid
description: The parameter profile id for the database
adDomainId:
type: string
format: uuid
description: Active Directory Domain id
optionProfileId:
type: string
format: uuid
description: The options profile for the database
ServiceInstanceEngineInfo:
title: TessellServiceInstanceInfo
description: This field details the DB Service Instance engine configuration details like - access mode
type:
- object
- 'null'
properties:
oracleConfig:
$ref: '#/components/schemas/ServiceInstanceOracleEngineConfig'
CloneTessellServicePayload:
title: CloneTessellServicePayload
allOf:
- type: object
properties:
snapshotId:
type: string
format: uuid
description: Tessell service snapshot Id, using which the clone is to be created
pitr:
type: string
description: PITR Timestamp, using which the clone is to be created
refreshSchedule:
$ref: '#/components/schemas/CreateUpdateRefreshSchedulePayload'
sourceType:
$ref: '#/components/schemas/CloneSourceType'
description: Source type for clone operation. Defaults to SNAPSHOT if not provided.
backupId:
type: string
format: uuid
description: Native backup ID. Required when sourceType is NATIVE_BACKUP and pitr is not provided. If pitr is provided with sourceType NATIVE_BACKUP, system resolves backup chain automatically.
- $ref: '#/components/schemas/ProvisionServicePayload'
ComputeProviderType:
type: string
enum:
- AWS_EC2
- AZURE_VM
- GCP_GCE
- OCI_EXADATA
- AZURE_EXADATA
- AWS_EXADATA
MilvusIndexConfig:
type: object
properties:
indexSpecifications:
type: array
items:
$ref: '#/components/schemas/IndexSpecification'
PrecheckStatus:
type: string
description: Status of an individual precheck
enum:
- PENDING
- PASS
- FAIL
- SKIPPED
databaseEngineType:
description: Database Engine Type
type: string
enum:
- ORACLE
- POSTGRESQL
- SQLSERVER
- MYSQL
- APACHE_KAFKA
- MONGODB
- MILVUS
TessellServiceInstanceRole:
type: string
description: DB Service instance role
enum:
- primary
- read_only_replica
- failover_replica
- dr
ScriptInfo:
title: ScriptInfo
type:
- object
- 'null'
properties:
scriptId:
type: string
format: uuid
description: The Tessell Script ID
scriptName:
type: string
description: The Tessell Script Name
scriptVersion:
type: string
description: The Tessell Script version
useActiveVersion:
type: boolean
default: false
description: 'When set to true, the scriptVersion field should be null and the system
will automatically use the active version of the script.
When set to false (default), the scriptVersion field specifies the
exact version to use.
'
ComputeConfigPayload:
type: object
required:
- provider
properties:
provider:
$ref: '#/components/schemas/ComputeProviderType'
exadataConfig:
$ref: '#/components/schemas/ExadataComputeConfigPayload'
CredentialsPayload:
type: object
description: Payload for Credential details
required:
- user
- password
properties:
user:
type: string
minLength: 1
maxLength: 256
description: Username
password:
type: string
minLength: 1
maxLength: 256
description: Password
BackupCustomRpoPolicy:
description: This is the definition of Custom RPO Policy for Backup for Tessell DB Service
allOf:
- $ref: '#/components/schemas/CustomRpoPolicy'
ExadataComputeConfigPayload:
type: object
required:
- infrastructureId
- vmClusterId
properties:
infrastructureId:
type: string
format: uuid
vmClusterId:
type: string
format: uuid
computeId:
type: string
format: uuid
DailySchedule:
type: object
properties:
backupsPerDay:
type: integer
format: int32
description: The number of backups to be captured per day.
minimum: 0
OraclePdbConfig:
type: object
properties:
name:
type: string
description: Name of the PDB
username:
type: string
description: Username for the PDB
password:
type: string
description: Password for the PDB
postScriptInfo:
$ref: '#/components/schemas/ScriptInfo'
description: 'Optional: Post-provisioning script to run after PDB is created.
'
rpoPolicyConfig:
$ref: '#/components/schemas/RpoPolicyConfig'
description: 'Optional: RPO policy configuration for PDB-level native backups (not snapshots).
This policy governs automated native backup schedules for this specific PDB.
If PITR (includeTransactionLogs) is enabled in this policy, the parent CDB must also have PITR enabled.
Note: This does not affect snapshot-based backups, which are managed at the service level.
'
WeeklySchedule:
type: object
properties:
days:
description: Days in a week to retain weekly backups for
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/WeekDay'
x-enum: true
tessellServiceTopology:
type: string
description: DB Service topology. This would specify whether the DB Service is single-node, or multi-node.
enum:
- single_instance
- high_availability
TessellServiceConnectivityInfoPayload:
title: TessellServiceConnectivityInfoPayload
type: object
description: DB Service connectivity details
required:
- servicePort
properties:
enableSSL:
type: boolean
default: false
dnsPrefix:
type: string
description: If not specified, Tessell will use a randomly generated prefix
servicePort:
description: The connection port for the DB Service
type: integer
format: int32
minimum: 0
enablePublicAccess:
description: Specify whether to enable public access to the DB Service, default false
type: boolean
default: false
allowedIpAddresses:
description: The list of allowed ipv4 addresses that can connect to the DB Service
type: array
items:
type: string
format: ip4
TimeFormat:
title: TimeFormat
description: Clock time format value in hour and minute.
type: object
required:
- hour
- minute
properties:
hour:
type: integer
format: int32
minimum: 0
maximum: 23
default: 1
minute:
type: integer
format: int32
minimum: 0
maximum: 59
default: 0
MilvusDatatype:
type: string
enum:
- VARCHAR
- INT64
- BOOL
- INT8
- INT16
- INT32
- FLOAT
- DOUBLE
- JSON
- BINARY_VECTOR
- FLOAT_VECTOR
RpoPolicyConfig:
description: This is the definition for RPO Policy details for Tessell DB Service
type: object
required:
- enableAutoSnapshot
properties:
includeTransactionLogs:
description: Determines whether transaction logs should be retained to enable Point-In-Time Recovery (PITR) functionality
type: boolean
default: false
enableAutoSnapshot:
description: Specify whether system will take automatic snapshots
type: boolean
default: true
standardPolicy:
$ref: '#/components/schemas/StandardRpoPolicy'
customPolicy:
$ref: '#/components/schemas/CustomRpoPolicy'
fullBackupSchedule:
$ref: '#/components/schemas/FullBackupSchedule'
enableAutoBackup:
description: Specify whether system will take automatic backups
type: boolean
default: false
backupRpoConfig:
type: object
description: Config for the Native Backup RPO policies
properties:
fullBackupSchedule:
$ref: '#/components/schemas/FullBackupSchedule'
standardPolicy:
$ref: '#/components/schemas/BackupStandardRpoPolicy'
customPolicy:
$ref: '#/components/schemas/BackupCustomRpoPolicy'
ProvisionServicePayload:
title: ProvisionServicePayload
type: object
required:
- name
- subscription
- engineType
- topology
- softwareImage
- softwareImageVersion
- serviceConnectivity
- creds
- engineConfiguration
properties:
name:
type: string
description: DB Service name
description:
type: string
description: DB Service's description
subscription:
type: string
description: Tessell Subscription in which the DB Service is to be created
edition:
type: string
engineType:
$ref: '#/components/schemas/databaseEngineType'
topology:
$ref: '#/components/schemas/tessellServiceTopology'
numOfInstances:
type: integer
format: int32
default: 0
minimum: 0
maximum: 5
description: 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.
softwareImage:
type: string
description: Software Image to be used to create the DB Service
softwareImageVersion:
type: string
description: Software Image Version to be used to create the DB Service
autoMinorVersionUpdate:
type: boolean
default: true
description: Specify whether to automatically update minor version for DB Service
enableDeletionProtection:
type: boolean
default: true
description: Specify whether to enable deletion protection for the DB Service
enableStopProtection:
type: boolean
default: false
description: Specify whether to enable stop protection for the DB Service
enablePerfInsights:
type: boolean
default: true
description: Specify whether to enable perf insights for the DB Service
infrastructure:
$ref: '#/components/schemas/ProvisionInfraPayload'
instances:
description: The instances (nodes) for this DB Service
type: array
items:
$ref: '#/components/schemas/AddDbServiceInstancePayloadV2'
serviceConnectivity:
$ref: '#/components/schemas/TessellServiceConnectivityInfoPayload'
creds:
$ref: '#/components/schemas/TessellServiceCredsPayload'
maintenanceWindow:
$ref: '#/components/schemas/TessellServiceMaintenanceWindow'
autoPatchConfig:
$ref: '#/components/schemas/AutoPatchConfig'
description: Configuration for automatic OS and DB patching during maintenance windows
serverPatchingConfig:
$ref: '#/components/schemas/ServerPatchingConfig'
description: Configuration for server patching with pre and post scripts
deletionConfig:
$ref: '#/components/schemas/TessellServiceDeletionConfig'
snapshotConfiguration:
$ref: '#/components/schemas/SnapshotConfigurationPayload'
rpoPolicyConfig:
$ref: '#/components/schemas/RpoPolicyConfig'
engineConfiguration:
$ref: '#/components/schemas/TessellServiceEngineConfigurationPayload'
databases:
description: Specify the databases to be created in the DB Service
type: array
items:
$ref: '#/components/schemas/CreateDatabasePayload'
integrationsConfig:
$ref: '#/components/schemas/TessellServiceIntegrationsPayload'
tags:
type: array
description: The tags to be associated with the DB Service
items:
$ref: '#/components/schemas/TessellTag'
tessellServicePrecheckId:
type:
- string
- 'null'
format: uuid
description: The precheck ID from a previously run precheck validation. If provided, the system will verify the precheck results before provisioning.
ServiceResizeConfig:
title: ServiceResizeConfig
allOf:
- $ref: '#/components/schemas/CommonResizeConfig'
- type: object
properties:
storage:
type: integer
format: int64
description: The new storage (in bytes) for the service
ProvisionInfraPayload:
title: ProvisionInfraPayload
type: object
description: The infra details where the DB Service is to be provisioned
required:
- cloud
properties:
cloud:
type: string
description: The cloud-type in which the DB Service is to be provisioned (ex. aws, azure)
region:
type: string
description: The region in which the DB Service is to be provisioned
availabilityZone:
type: string
description: The availability-zone in which the DB Service is to be provisioned
vpc:
type: string
description: The VPC for compute to be used for provisioning the DB Service
privateSubnet:
type: string
description: The private subnet for compute to be used for provisioning the DB Service
enableEncryption:
type: boolean
default: false
description: Specify whether to enable the encryption at rest for the DB Service.
encryptionKey:
type:
- string
- 'null'
description: The encryption key name which is to be used to encrypt the data at rest. This is honoured only if 'enableEncryption' is true. If this is not specified, Tessell will use a default out-of-the-box encryption key.
computeType:
type: string
description: The compute-type to be used for provisioning the DB Service
awsInfraConfig:
$ref: '#/components/schemas/AwsInfraConfig'
gcpInfraConfig:
$ref: '#/components/schemas/GcpInfraConfig'
additionalStorage:
type: integer
format: int64
default: 0
minimum: 0
description: 'The additional storage (in bytes) to be provisioned for the DB Service for cloud native storages.
This is in addition to what is specified in the compute type.
'
enableComputeSharing:
type: boolean
default: false
description: Specify if the computes should be shared across DB Services
computeNamePrefix:
type:
- string
- 'null'
maxLength: 30
description: If not specified, it will be autogenerated
timezone:
$ref: '#/components/schemas/TimeZone'
x-patchable: true
computes:
type: array
items:
$ref: '#/components/schemas/ProvisionComputePayload'
iops:
type: integer
format: int32
minimum: 0
maximum: 10000000
description: IOPS required for the DB Service
throughput:
type: integer
format: int32
minimum: 0
maximum: 100000
description: Throughput in MB/s required for the DB Service
CloneSourceType:
description: Source type for clone/refresh operation
type: string
enum:
- SNAPSHOT
- NATIVE_BACKUP
PrecheckStatusResponse:
type: object
description: Response for precheck status polling
properties:
tessellServicePrecheckId:
type: string
format: uuid
description: Unique identifier for the precheck request
status:
$ref: '#/components/schemas/PrecheckOverallStatus'
ServiceInstanceOracleEngineConfig:
title: TessellServiceInstanceOracleEngineConfig
type:
- object
- 'null'
properties:
accessMode:
$ref: '#/components/schemas/InstanceAccessMode'
DbCollectionIndexPayload:
type: object
properties:
fieldName:
type: string
indexName:
type: string
milvusIndexConfig:
$ref: '#/components/schemas/MilvusIndexConfig'
AwsInfraConfig:
type: object
title: AwsInfraConfig
properties:
awsCpuOptions:
type: object
title: AwsCpuOptions
properties:
vcpus:
type: integer
format: int32
minimum: 0
description: Number of vcpus for aws cpu options
CommonResizeConfig:
title: CommonResizeConfig
type: object
properties:
computeType:
type: string
description: The new compute type for the service/instance
parameterProfileId:
type: string
format: uuid
description: Mandatory when providing compute type
iops:
type: integer
format: int32
description: The new IOPS for the service/instance
throughput:
type: integer
format: int32
description: The new Throughput for the service/instance
SecurityConfigPayload:
type: object
properties:
securityProfileId:
type: string
format: uuid
description: Security Profile Id to be associated with the compute
MilvusCreateCollectionConfig:
title: MilvusCreateCollectionConfig
type:
- object
- 'null'
properties:
name:
type: string
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
minLength: 1
maxLength: 255
shardNums:
type:
- integer
- 'null'
minimum: 1
maximum: 16
numPartitions:
type:
- integer
- 'null'
minimum: 1
maximum: 4096
schema:
type: object
properties:
description:
type:
- string
- 'null'
enableDynamicField:
type: boolean
fields:
type: array
items:
$ref: '#/components/schemas/MilvusCreateCollectionField'
TimeZone:
type: string
description: The timezone detail
maxLength: 256
MilvusIndexMetricType:
type: string
enum:
- L2
- IP
- JACCARD
- TANIMOTO
- HAMMING
- SUPERSTRUCTURE
- SUBSTRUCTURE
InstanceResizeConfig:
title: InstanceResizeConfig
allOf:
- $ref: '#/components/schemas/CommonResizeConfig'
- type: object
required:
- instanceId
properties:
instanceId:
type: string
format: uuid
description: UUID for the instance that needs to be resized.
CreateOracleDatabaseConfig:
title: CreateOracleDatabaseConfig
type:
- object
- 'null'
properties:
parameterProfileId:
type: string
format: uuid
description: The parameter profile ID for the database
optionsProfile:
type: string
description: The options profile for the database
optionProfileId:
type: string
format: uuid
description: The options profile for the database
username:
type: string
description: Username for the oracle database
password:
type: string
description: Password for the oracle database
pdbConfig:
type: array
items:
$ref: '#/components/schemas/OraclePdbConfig'
StandardRpoPolicy:
description: This is the definition of Standard RPO Policy for Snapshot for Tessell DB Service
type: object
required:
- retentionDays
- snapshotStartTime
properties:
retentionDays:
description: Number of days for which the snapshot of DB Service would be retained
type: integer
format: int32
minimum: 0
maximum: 35
includeTransactionLogs:
description: Determines whether transaction logs should be retained to enable Point-In-Time Recovery (PITR) functionality
type: boolean
default: false
snapshotStartTime:
$ref: '#/components/schemas/TimeFormat'
DbCollectionCreatePayload:
type: object
properties:
name:
type: string
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
minLength: 1
maxLength: 255
milvusCollectionConfig:
$ref: '#/components/schemas/MilvusCreateCollectionConfig'
AzureNetAppConfigPayload:
properties:
azureNetAppId:
description: Azure NetApp Id registered with Tessell
type: string
format: uuid
capacityPoolId:
description: Capacity pool Id of the Azure NetApp registered with Tessell
type: string
format: uuid
configurations:
description: Azure NetApp configurations
type: object
properties:
networkFeatures:
$ref: '#/components/schemas/AzureNetAppNetworkFeature'
PrecheckOverallStatus:
type: string
description: Overall status of the precheck process
enum:
- NOT_STARTED
- IN_PROGRESS
- COMPLETED
- FAILED
ApacheKafkaEngineConfigPayload:
title: ApacheKafkaEngineConfigPayload
type: object
properties:
parameterProfileId:
type: string
format: uuid
description: The parameter profile id for the database
RefreshScheduleRecurrenceInfo:
type: object
required:
- triggerTime
properties:
triggerTime:
$ref: '#/components/schemas/TimeFormat'
dailySchedule:
type: object
properties:
enabled:
type: boolean
weeklySchedule:
type: object
properties:
weekDays:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/WeekDay'
AddDbServiceInst
# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tessell/refs/heads/main/openapi/tessell-tessell-service-precheck-controller-api-openapi.yml