Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tessell tessell-service-precheck-controller API

The tessell-service-precheck-controller API from Tessell — 6 operation(s) for tessell-service-precheck-controller.

Tessell tessell-service-precheck-controller API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include tessell-service-precheck-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 6 operations across 6 paths, and defines 99 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, {server}.

6 operations 6 paths 99 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Tessell tessell-service-precheck-controller API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

tessell-service-precheck-controller 6
POST
/services/prechecks
Run prechecks for provisioning a DB service
runPrechecksForProvision 1 param body → 202default
GET
/services/prechecks/{id}/status
Get precheck status
getPrecheckStatus 2 params → 200default
GET
/services/prechecks/{id}/report
Get precheck report
getPrecheckReport 2 params → 200default
POST
/services/{service-id}/service-instances/prechecks
Run prechecks for adding service instances to a DB service
runPrechecksForServiceInstances 2 params body → 202default
POST
/services/{service-id}/resize/prechecks
Run prechecks for resizing a DB service
runPrechecksForResize 2 params body → 202default
POST
/availability-machines/{availability-machine-id}/clones/prechecks
Run prechecks for cloning a DB service
runPrechecksForClone 2 params body → 202default

Schemas 99

The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are ProvisionServicePayload (28 properties), ProvisionInfraPayload (17 properties), AddDbServiceInstancePayloadV2 (17 properties), ProvisionComputePayload (15 properties). Each schema is shown below with its type and property counts.

OracleEngineConfigPayload
object
8 properties 3 required
TessellServiceInstanceRole
string
DB Service instance role
AddDbServiceInstancesPayload
object
10 properties 3 required
ApiError
object
Common error response object for non 2xx responses
7 properties
PrecheckReportResponse
object
User-facing precheck report response
3 properties
commonYearlySchedule
WeekDay
string
Week Days
AwsInfraConfig
object
1 property
tessellServiceTopology
string
DB Service topology. This would specify whether the DB Service is single-node, or multi-node.
ScheduleInfo
object
5 properties
PrecheckStatus
string
Status of an individual precheck
WeeklySchedule
object
1 property
RefreshScheduleRecurrenceInfo
object
3 properties 1 required
CredentialsPayload
object
Payload for Credential details
2 properties 2 required
MongodbDatabaseConfig
object
1 property
PrePostScriptInfo
object
2 properties
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
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
AzureNetAppConfigPayload
object
3 properties
PrecheckOverallStatus
string
Overall status of the precheck process
Month
string
Name of a month
CreateUpdateRefreshSchedulePayload
object
4 properties
AddDbServiceInstancePayload
object
15 properties 1 required
InstanceAccessMode
string
Service instance access mode
PostgresqlDatabaseConfig
object
2 properties
TessellServiceIntegrationsPayload
object
Integrations to be enabled for the DB Service
1 property
MilvusCreateCollectionConfig
object
4 properties
MonthlySchedule
object
Definition for taking month specific schedule.
1 property
CommonResizeConfig
object
4 properties
ProvisionServicePayload
object
28 properties 9 required
PrecheckStatusResponse
object
Response for precheck status polling
2 properties
ExadataComputeConfigPayload
object
3 properties 2 required
InstanceResizeConfig
ServiceResizeConfig
PostgresqlEngineConfigPayload
object
5 properties 1 required
CustomRpoPolicy
object
This is the definition of Custom RPO Policy for Snapshot for Tessell DB Service
2 properties 2 required
ServerPatchingConfig
object
Configuration for server patching with pre and post scripts
5 properties
databaseEngineType
string
Database Engine Type
SecurityConfigPayload
object
1 property
ApacheKafkaEngineConfigPayload
object
1 property
AutoPatchConfig
object
Configuration for automatic patching during maintenance windows
5 properties
ProvisionComputePayload
object
15 properties
MilvusCreateCollectionField
object
10 properties
RefreshScheduleRefreshMode
StorageConfigPayload
object
The storage details to be provisioned.
3 properties 1 required
DBEngineCollationConfig
object
1 property
PrecheckItem
object
Individual precheck item for user-facing report
6 properties
BackupStandardRpoPolicy
object
This is the definition of Standard RPO Policy for Backup for Tessell DB Service
2 properties 1 required
IndexSpecification
object
3 properties
SqlServerDatabaseConfig
object
1 property
MilvusIndexConfig
object
1 property
GcpInfraConfig
object
1 property
MilvusIndexParameters
object
4 properties
ResizeDBServiceRequest
object
3 properties
CloneSourceType
string
Source type for clone/refresh operation
ComputeProviderType
string
OraclePdbConfig
object
5 properties
MilvusIndexType
string
MySqlEngineConfigPayload
object
3 properties 1 required
TessellServiceEngineConfigurationPayload
object
13 properties
DbCollectionIndexPayload
object
3 properties
RpoPolicyConfig
object
This is the definition for RPO Policy details for Tessell DB Service
7 properties 1 required
TimeFormat
object
Clock time format value in hour and minute.
2 properties 2 required
TessellServiceCredsPayload
object
DB Service's credential details
2 properties 2 required
TessellServiceConnectivityInfoPayload
object
DB Service connectivity details
5 properties 1 required
AddDbServiceInstancePayloadV2
object
17 properties 4 required
FsxNetAppConfigPayload
object
The FSx NetApp details to be provisioned
2 properties 2 required
MySqlDatabaseConfig
object
2 properties
BackupCustomRpoPolicy
This is the definition of Custom RPO Policy for Backup for Tessell DB Service
StorageProviderType
Storage Type in the cloud
ServiceInstanceOracleEngineConfig
object
1 property
SqlServerInstanceName
string
The named instance for SQL Server database (max 16 characters as per SQL Server limitation)
MilvusIndexMetricType
string
TessellTag
object
2 properties
StandardRpoPolicy
object
This is the definition of Standard RPO Policy for Snapshot for Tessell DB Service
3 properties 2 required
DailySchedule
object
1 property
SnapshotConfigurationPayload
MonthWiseDates
object
2 properties 2 required
ProvisionInfraPayload
object
The infra details where the DB Service is to be provisioned
17 properties 1 required
DatesForEachMonth
object
2 properties
MilvusDatabaseConfig
object
1 property
SqlServerEngineConfigPayload
object
5 properties 1 required
BackupType
string
Backup Content Type
ComputeConfigPayload
object
2 properties 1 required
MilvusEngineConfigPayload
object
1 property 1 required
InstanceSyncMode
string
Service instance sync mode
DbCollectionCreatePayload
object
2 properties
RefreshScheduleInfo
object
1 property
ScriptInfo
object
4 properties
ServiceInstanceEngineInfo
object
This field details the DB Service Instance engine configuration details like - access mode
1 property
TessellServiceMaintenanceWindow
object
Base class for maintenance window configurations. Supports multiple cadences: Weekly, Monthly, and Quarterly. Use concrete subclasses: WeeklyMaintenanceWindow,…
3 properties 3 required
CloneTessellServicePayload
CreateOracleDatabaseConfig
object
6 properties
CreateDatabasePayload
object
5 properties
MongodbEngineConfigPayload
object
2 properties 2 required
YearlySchedule
object
2 properties
FullBackupSchedule
object
The schedule at which full backups would be triggered
2 properties
TimeZone
string
The timezone detail
MilvusDatatype
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-tessell-service-precheck-controller-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