Tessell data-pipeline API
The data-pipeline API from Tessell — 14 operation(s) for data-pipeline.
Tessell data-pipeline API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include data-pipeline. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 16 operations across 14 paths, and defines 165 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, {server}.
16 operations
14 paths
165 schemas
2 DELETE8 GET4 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tessell data-pipeline API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
Paths & Operations 16
Across 14 paths, the API surfaces 16 operations — 2 DELETE, 8 GET, 4 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
data-pipeline 16
GET
/data-pipelines
Get details of all the data pipelines
POST
/data-pipelines
GET
/data-pipelines/{id}
DELETE
/data-pipelines/{id}
PATCH
/data-pipelines/{id}/resume
PATCH
/data-pipelines/{id}/pause
GET
/data-pipelines/{id}/db-services/{dp-db-service-id}/db-schema
DELETE
/data-pipelines/{id}/db-services/{dp-db-service-id}
PATCH
/data-pipelines/{id}/db-services/{dp-db-service-id}/resume
PATCH
/data-pipelines/{id}/db-services/{dp-db-service-id}/pause
POST
/data-pipelines/db-services/{service-id}/publish-data
GET
/data-pipelines/{id}/events/create/track
Track the progress of the ongoing data pipeline creation operation
GET
/data-pipelines/db-services/{dp-db-service-id}/events/track
Track the progress of the ongoing data pipeline DB service operation
GET
/data-pipelines/{id}/metrics/event-hub
Returns the metrics data for Azure Event Hub Namespace
GET
/data-pipelines/{id}/eligible-db-services
Returns the list of eligible DB services for the Data Pipeline
GET
/data-pipelines/db-services/{id}/eligible-pipelines
Returns the list of eligible Data Pipelines for the DB Service
Schemas 165
The contract defines 165 schemas that model the data the API accepts and returns. The most detailed are TessellServiceDTO (43 properties), TessellServiceInstanceDTO (43 properties), TessellServiceInfrastructureInfo (21 properties), DataPipeline (14 properties). Each schema is shown below with its type and property counts.
TessellServiceInstanceRole
string
DB Service instance role
AzureEventHubMonitoringChart
object
7 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
DataPipelineInfraResource
object
2 properties
commonYearlySchedule
TessellServiceClonedFromInfo
object
If the DB Service is created as a clone from some other DB Service, this section describes the parent DB Service and cloning details
14 properties
AzureNetAppCapacityPoolServiceLevel
string
apiResponse
object
2 properties
TessellServiceStatus
string
The current status of the DB Service
WeekDay
string
Week Days
EntityAclSharingInfo
object
Tessell Entity ACL Sharing Info
1 property
TessellServiceSqlServerEngineConfig
object
5 properties
TessellServiceDatabaseConnectString
object
4 properties
AwsInfraConfig
object
1 property
PerfInsightsStatus
string
Perf insights status of a Service Instance
tessellServiceTopology
string
DB Service topology. This would specify whether the DB Service is single-node, or multi-node.
SourceConfigPayload
object
6 properties
5 required
ScheduleInfo
object
5 properties
DatabaseConfiguration
object
6 properties
WeeklySchedule
object
1 property
TessellServiceConnectString
object
DB Service connect string info
6 properties
RefreshServiceInfo
object
Service refresh details
7 properties
MongodbDatabaseConfig
object
1 property
InstanceExadataComputeConfig
object
6 properties
6 required
PrePostScriptInfo
object
2 properties
DataPipeline
object
14 properties
ServiceAzureNetAppConfig
object
1 property
TessellServicesResponse
TessellResourceUpdateInfo
object
In progress update information for a Tessell Resource
4 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
DataPipelineSinkAdapter
object
2 properties
DataPipelinePayload
object
10 properties
6 required
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
AzureNetAppEncryptionKeySource
ParameterProfile
object
4 properties
DataPipelineStatus
string
MaintenanceCadence
string
Frequency of maintenance window
DbServicePrivateLinkStatus
string
DB Service's private link status
Month
string
Name of a month
InstanceAzureNetAppConfig
object
Service instance level Azure NetApp config
10 properties
TessellServiceIntegrationsInfo
object
Tessell provides support to integrate third party softwares with DB Services. This fields details the information about what third-party integrations are confi…
1 property
DataPipelineSinkType
string
TessellServiceInstanceContextInfo
object
Provide more context of Service Instance state
2 properties
SinkConfigPayload
object
2 properties
2 required
TessellServiceInstanceDTO
object
This is a definition of the DB Service Instance object
43 properties
1 required
PrivateLinkPayload
object
The interface endpoint or Gateway Load Balancer endpoint to connect to your DB service.
2 properties
DatabaseSchemaDb
object
Represents a database instance within the schema structure.
3 properties
PatchType
string
Type of patch
TessellServiceEngineInfo
object
This field details the DB Service engine configuration details like - parameter profile, or options profile (if applicable) are used to configure the DB Servic…
13 properties
InstanceAccessMode
string
Service instance access mode
PrivateLinkStatus
string
Tessell Private Link Status
DatabaseSchemaDbSchemaTable
object
Represents a table within a schema.
5 properties
TaskStatus
string
The status of Task
PostgresqlDatabaseConfig
object
2 properties
DpDbSvcTrackingDetails
object
Execution details of data pipeline DB Service operation
3 properties
cloudType
string
Tessell supported cloud types
OraclePdbConfigTaskPayload
object
6 properties
taskSummary
object
5 properties
TessellServiceOracleEngineConfig
object
9 properties
TessellServiceInstanceConnectString
object
4 properties
PatchActivity
object
6 properties
TessellServiceDTO
object
This is a definition of the DB Service object
43 properties
MonthlySchedule
object
Definition for taking month specific schedule.
1 property
TessellServiceConnectivityInfo
object
DB Service's connectivity information
10 properties
CreateDataPipelineTrackingDetails
object
Execution details of data pipeline creation
5 properties
DataPipelineSinkAdapterType
string
DataPipelineDbService
object
9 properties
DataPipelineExecutionOutput
EntityUserAclSharingInfo
object
Tessell Entity ACL Sharing Info for a user
4 properties
PortAccessConfig
object
3 properties
TessellServiceConnectivityUpdateInProgressInfo
object
DB Service connectivity update-in-progress details
5 properties
OptionProfile
object
4 properties
DataPipelineDbServiceSchema
object
3 properties
TessellServiceMilvusEngineConfig
object
1 property
TessellServiceInstanceStatus
string
DB Service instance status
TrackStepError
object
Step error details
4 properties
CloudRegionInfo
object
Cloud and region details
2 properties
1 required
TessellServiceMySqlEngineConfig
object
3 properties
SecurityProfileSyncStatus
string
Sync status of the security profile applied on an instance/server
DatabaseSchema
object
Represents the complete schema structure of a database, including databases, schemas within databases, tables, and columns.
1 property
AzureNetAppEncryptionKeyInfo
object
Details of encryption key
4 properties
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
TessellDatabaseDTO
object
12 properties
ServiceUpcomingScheduledActions
object
3 properties
DBEngineCollationConfig
object
1 property
DatabaseSchemaDbSchema
object
Represents a schema within a database instance.
3 properties
TessellDatabaseClonedFromInfo
object
If a database is created as a clone from some other DB Service's database, this section describes the original database details
1 property
OracleDatabaseConfig
object
5 properties
ParameterProfileStatus
string
Association status of the instance to the parameter profile
apiPaginationInfo
object
2 properties
BackupStandardRpoPolicy
object
This is the definition of Standard RPO Policy for Backup for Tessell DB Service
2 properties
1 required
SqlServerDatabaseConfig
object
1 property
TessellServiceMongodbEngineConfig
object
2 properties
GcpInfraConfig
object
1 property
ConnectStringUsageType
string
Usage type of connection string.
DataPipelineMicrosoftFabricConfig
object
1 property
TrackProgress
object
Progress of the execution
2 properties
DataPipelineSourceAdapter
object
11 properties
CloneSourceType
string
Source type for clone/refresh operation
ServiceStorageConfig
object
2 properties
ComputeProviderType
string
DataPipelineDbServiceMetadata
object
1 property
apiMetadata
object
3 properties
TessellServiceSubStatus
string
DB Service could have a sub status associated along with status
UpcomingMaintenanceWindowInfo
object
Information about the upcoming maintenance window
7 properties
DatabaseStatus
string
ActivityStatus
string
The status of Activity
TessellServiceInstanceType
string
DB Service instance type
RpoPolicyConfig
object
This is the definition for RPO Policy details for Tessell DB Service
7 properties
1 required
InstanceFsxNetAppConfig
object
5 properties
OptionProfileStatus
string
Association status of the instance to the option profile
DatabaseSchemaDbSchemaTableColumn
object
Represents a column within a table.
4 properties
TimeFormat
object
Clock time format value in hour and minute.
2 properties
2 required
ServiceDataPipelinePublishPayload
object
3 properties
3 required
SinkAdapterConfig
object
1 property
ServiceUpdates
object
Update availability information for a DB Service
2 properties
AzureDataPipelineExecutionOutputResources
object
3 properties
1 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)
ConnectStringType
string
Connect string type
PerfInsightsConfig
object
3 properties
TessellTag
object
2 properties
InstanceStorageConfig
object
4 properties
DailySchedule
object
1 property
StandardRpoPolicy
object
This is the definition of Standard RPO Policy for Snapshot for Tessell DB Service
3 properties
2 required
TessellServicePostgresqlEngineConfig
object
5 properties
MonthWiseDates
object
2 properties
2 required
TessellServiceContextInfo
object
Provide more context of DB Service state
2 properties
DatesForEachMonth
object
2 properties
MilvusDatabaseConfig
object
1 property
TessellMonitoringMetricsDTO
object
This is a definition for Tessell Monitoring Metrics
6 properties
RegionInfo
object
Cloud region details
2 properties
1 required
tessellServiceLicenseType
string
DB Service License Type
DataPipelinesResponse
TessellServiceGenieStatus
string
DB Service's Genie status
MonitoringConfig
object
1 property
TessellServiceInfrastructureInfo
object
This field contains DB Service's infrastructure related information, like, where the service is hosted - cloud, region; what compute shape, or network is is co…
21 properties
BackupType
string
Backup Content Type
DBServiceCloneType
string
SecurityConfigOps
object
1 property
InstanceSyncMode
string
Service instance sync mode
PrivateLinkInfo
object
4 properties
InstanceComputeConfig
object
2 properties
ScriptInfo
object
4 properties
ContextInfo
object
Provide more context of the state
2 properties
DataPipelineDbServiceStatusOps
object
ServiceInstanceEngineInfo
object
This field details the DB Service Instance engine configuration details like - access mode
1 property
SecurityProfileInfoOps
object
3 properties
TessellServiceMaintenanceWindow
object
Base class for maintenance window configurations. Supports multiple cadences: Weekly, Monthly, and Quarterly. Use concrete subclasses: WeeklyMaintenanceWindow,…
3 properties
3 required
ComputeConnectivityConfig
object
2 properties
TessellServiceInstanceSubStatus
string
DB Service Instance could have a sub status associated along with status
TrackStep
object
Step details
8 properties
AssociatedActivities
object
3 properties
DeletionScheduleDTO
object
Details of the deletion schedule on a DB Service
3 properties
1 required
YearlySchedule
object
2 properties
AvailableUpdatesSimple
object
Simple boolean flags indicating available updates
2 properties
TessellServiceApacheKafkaEngineConfig
object
1 property
FullBackupSchedule
object
The schedule at which full backups would be triggered
2 properties
TimeZone
string
The timezone detail
AzureDataPipelineExecutionOutput
object
5 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tessell 12
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
#data-pipeline