The tessell-service-precheck-controller API from Tessell — 6 operation(s) for tessell-service-precheck-controller.
openapi: 3.0.3
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:
OracleEngineConfigPayload:
title: OracleEngineConfigPayload
type: object
required:
- parameterProfileId
- characterSet
- nationalCharacterSet
properties:
multiTenant:
type: boolean
default: false
description: Specify whether the DB Service is multi-tenant.
sid:
type: string
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
characterSet:
type: string
description: The character-set for the database
nationalCharacterSet:
type: string
description: The national-character-set for the database
enableArchiveMode:
type: boolean
default: true
description: To explicitly enable archive mode, when PITR is disabled
TessellServiceInstanceRole:
type: string
description: DB Service instance role
enum:
- primary
- read_only_replica
- failover_replica
- dr
AddDbServiceInstancesPayload:
title: AddDbServiceInstancesPayload
type: object
required:
- cloud
- region
- instances
properties:
instanceNamePrefix:
type: string
maxLength: 10
cloud:
type: string
description: The cloud-type in which the instance is to be provisioned (ex. aws, azure)
region:
type: string
description: The region in which the instance is to be provisioned
vpc:
type: string
description: 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.
computeType:
type: string
description: The compute-type to be used for provisioning the instance. If not specified, it will be inherited from the current primary instance.
enablePerfInsights:
type: boolean
default: true
description: Specify whether to enable perf insights for the DB instances
awsInfraConfig:
$ref: '#/components/schemas/AwsInfraConfig'
gcpInfraConfig:
$ref: '#/components/schemas/GcpInfraConfig'
instances:
type: array
items:
$ref: '#/components/schemas/AddDbServiceInstancePayload'
tessellServicePrecheckId:
type: string
format: uuid
nullable: true
description: The precheck ID from a previously run precheck validation. If provided, the system will verify the precheck results before adding service instances.
ApiError:
type: object
description: Common error response object for non 2xx responses
properties:
code:
type: string
description: Status code for the error response
message:
type: string
description: Error message for API response
resolution:
type: string
timestamp:
type: string
format: date-time
contextId:
type: string
description: ContextId of API request
sessionId:
type: string
description: SessionId of API request
tessellErrorCode:
type: string
description: Unique error code specific to Tessell
PrecheckReportResponse:
type: object
description: User-facing precheck report response
properties:
tessellServicePrecheckId:
type: string
format: uuid
description: Unique identifier for the precheck request
status:
$ref: '#/components/schemas/PrecheckOverallStatus'
checks:
type: array
description: List of individual precheck results
items:
$ref: '#/components/schemas/PrecheckItem'
commonYearlySchedule:
allOf:
- $ref: '#/components/schemas/DatesForEachMonth'
- type: object
properties:
months:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/Month'
x-enum: true
WeekDay:
description: Week Days
type: string
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
x-enum-varnames:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
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
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
ScheduleInfo:
type: object
properties:
backupStartTime:
$ref: '#/components/schemas/TimeFormat'
dailySchedule:
$ref: '#/components/schemas/DailySchedule'
weeklySchedule:
$ref: '#/components/schemas/WeeklySchedule'
monthlySchedule:
$ref: '#/components/schemas/MonthlySchedule'
yearlySchedule:
$ref: '#/components/schemas/YearlySchedule'
PrecheckStatus:
type: string
description: Status of an individual precheck
enum:
- PENDING
- PASS
- FAIL
- SKIPPED
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
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'
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
MongodbDatabaseConfig:
title: MongodbDatabaseConfig
type: object
nullable: true
properties:
parameterProfileId:
type: string
format: uuid
description: The parameter profile ID for the database
PrePostScriptInfo:
type: object
properties:
preScriptInfo:
type: array
items:
$ref: '#/components/schemas/ScriptInfo'
postScriptInfo:
type: array
items:
$ref: '#/components/schemas/ScriptInfo'
TessellServiceDeletionConfig:
title: TessellServiceDeletionConfig
description: If the DB Service is to be deleted, this config would be honoured if no preference is provided during deleting the service
x-patchable: true
properties:
retainAvailabilityMachine:
type: boolean
default: false
x-patchable: true
description: If specified as true, the associated Availability Machine (snapshots, sanitized-snapshots, logs) would be retained
AzureNetAppNetworkFeature:
description: Azure NetApp network feature configuration for creating volume
type: string
enum:
- Standard
- Basic
x-enum-varnames:
- STANDARD
- BASIC
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
Month:
description: Name of a month
type: string
enum:
- January
- February
- March
- April
- May
- June
- July
- August
- September
- October
- November
- December
x-enum-varnames:
- January
- February
- March
- April
- May
- June
- July
- August
- September
- October
- November
- December
CreateUpdateRefreshSchedulePayload:
properties:
refreshMode:
$ref: '#/components/schemas/RefreshScheduleRefreshMode'
contentType:
$ref: '#/components/schemas/BackupType'
scriptInfo:
$ref: '#/components/schemas/PrePostScriptInfo'
scheduleInfo:
$ref: '#/components/schemas/RefreshScheduleInfo'
AddDbServiceInstancePayload:
title: AddDbServiceInstancePayload
type: object
required:
- role
properties:
name:
type: string
maxLength: 30
description: Name of the instance
role:
$ref: '#/components/schemas/TessellServiceInstanceRole'
availabilityZone:
type: string
description: The availability-zone in which the instance is to be provisioned
privateSubnet:
type: string
description: The private subnet in which the instance is to be provisioned
computeId:
type: string
format: uuid
description: ID of the Compute Resource
parameterProfileId:
type: string
format: uuid
description: ID of the Parameter Profile to be used for instance
computeName:
type: string
description: The compute-name of instance provided by the User
iops:
type: integer
format: int32
minimum: 0
maximum: 10000000
description: IOPS required for the DB Service Instance
throughput:
type: integer
format: int32
minimum: 0
maximum: 100000
description: Throughput in MB/s required for the DB Service Instance
syncMode:
$ref: '#/components/schemas/InstanceSyncMode'
engineConfiguration:
$ref: '#/components/schemas/ServiceInstanceEngineInfo'
computeConfig:
$ref: '#/components/schemas/ComputeConfigPayload'
storageConfig:
$ref: '#/components/schemas/StorageConfigPayload'
archiveStorageConfig:
$ref: '#/components/schemas/StorageConfigPayload'
securityConfig:
$ref: '#/components/schemas/SecurityConfigPayload'
InstanceAccessMode:
type: string
description: Service instance access mode
enum:
- OPEN_MODE
- MOUNT_MODE
PostgresqlDatabaseConfig:
title: PostgresqlDatabaseConfig
type: object
nullable: true
properties:
parameterProfileId:
type: string
format: uuid
description: The parameter profile ID for the database
optionProfileId:
type: string
format: uuid
description: The options profile for the database
TessellServiceIntegrationsPayload:
title: TessellServiceIntegrationsPayload
description: Integrations to be enabled for the DB Service
type: object
nullable: true
x-patchable: true
properties:
integrations:
type: array
nullable: true
items:
type: string
format: uuid
MilvusCreateCollectionConfig:
title: MilvusCreateCollectionConfig
type: object
nullable: true
properties:
name:
type: string
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
minLength: 1
maxLength: 255
shardNums:
type: integer
nullable: true
minimum: 1
maximum: 16
numPartitions:
type: integer
nullable: true
minimum: 1
maximum: 4096
schema:
type: object
properties:
description:
type: string
nullable: true
enableDynamicField:
type: boolean
fields:
type: array
items:
$ref: '#/components/schemas/MilvusCreateCollectionField'
MonthlySchedule:
description: Definition for taking month specific schedule.
type: object
properties:
commonSchedule:
$ref: '#/components/schemas/DatesForEachMonth'
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
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
format: uuid
nullable: true
description: The precheck ID from a previously run precheck validation. If provided, the system will verify the precheck results before provisioning.
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'
ExadataComputeConfigPayload:
type: object
required:
- infrastructureId
- vmClusterId
properties:
infrastructureId:
type: string
format: uuid
vmClusterId:
type: string
format: uuid
computeId:
type: string
format: uuid
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.
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
PostgresqlEngineConfigPayload:
title: PostgresEngineConfigPayload
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
proxyPort:
type: integer
format: int32
minimum: 0
optionsProfile:
type: string
description: The options profile for the database
optionProfileId:
type: string
format: uuid
description: The options profile for the database
CustomRpoPolicy:
description: This is the definition of Custom RPO Policy for Snapshot for Tessell DB Service
type: object
required:
- name
- schedule
properties:
name:
type: string
description: Custom RPO policy name
schedule:
$ref: '#/components/schemas/ScheduleInfo'
ServerPatchingConfig:
title: ServerPatchingConfig
type: object
description: Configuration for server patching with pre and post scripts
properties:
enableAutoOSPatching:
type: boolean
default: false
description: Enable automatic OS patching for the server
preScriptInfo:
$ref: '#/components/schemas/ScriptInfo'
description: Pre-script to run before patching
postScriptInfo:
$ref: '#/components/schemas/ScriptInfo'
description: Post-script to run after patching
ignorePreScriptFailure:
type: boolean
default: false
description: Ignore pre-script failure and continue with patching
ignorePostScriptFailure:
type: boolean
default: false
description: Ignore post-script failure and mark patching as successful
example:
enableAutoOSPatching: true
preScriptInfo:
scriptId: 123e4567-e89b-12d3-a456-426614174000
scriptVersion: v1.0
postScriptInfo:
scriptId: 123e4567-e89b-12d3-a456-426614174001
scriptVersion: v1.0
databaseEngineType:
description: Database Engine Type
type: string
enum:
- ORACLE
- POSTGRESQL
- SQLSERVER
- MYSQL
- APACHE_KAFKA
- MONGODB
- MILVUS
SecurityConfigPayload:
type: object
properties:
securityProfileId:
type: string
format: uuid
description: Security Profile Id to be associated with the compute
ApacheKafkaEngineConfigPayload:
title: ApacheKafkaEngineConfigPayload
type: object
properties:
parameterProfileId:
type: string
format: uuid
description: The parameter profile id for the database
AutoPatchConfig:
title: AutoPatchConfig
type: object
description: Configuration for automatic patching during maintenance windows
properties:
osAutoPatchEnabled:
type: boolean
default: false
description: 'Enable automatic OS patching to latest certified minor version.
Only minor version patches are applied automatically.
Major version upgrades require manual intervention.'
dbAutoPatchEnabled:
type: boolean
default: false
description: 'Enable automatic DB patching.
Note: Currently not supported as DB patches require customer approval
due to application compatibility concerns.'
patchStrategy:
type: string
enum:
- LATEST_CERTIFIED
- SPECIFIC_VERSION
default: LATEST_CERTIFIED
description: 'Strategy for selecting patch versions:
- LATEST_CERTIFIED: Apply the latest certified patch version (recommended)
- SPECIFIC_VERSION: Apply a specific version (requires specificOsVersion/specificDbVersion)'
specificOsVersion:
type: string
description: 'Specific OS version to patch to (only when patchStrategy is SPECIFIC_VERSION).
Example: "RHEL-8.7", "Ubuntu-22.04.3"'
specificDbVersion:
type: string
description: 'Specific DB version to patch to (only when patchStrategy is SPECIFIC_VERSION).
Example: "PostgreSQL-14.9", "Oracle-19.21"'
example:
osAutoPatchEnabled: true
dbAutoPatchEnabled: false
patchStrategy: LATEST_CERTIFIED
ProvisionComputePayload:
type: object
title: ProvisionComputePayload
properties:
name:
type: string
instanceGroupName:
type: string
region:
type: string
description: The region in which the compute is to be provisioned
availabilityZone:
type: string
description: The availability-zone in which the compute is to be provisioned
role:
$ref: '#/components/schemas/TessellServiceInstanceRole'
vpc:
type: string
description: The VPC to be used for provisioning the compute resource
privateSubnet:
type: string
description: The private subnet to be used for provisioning the compute resource
computeType:
type: string
description: The compute-type to be used for provisioning the compute resource
computeName:
type: string
description: The compute-name of instance provided by the User
co
# --- 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