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

TetraScience Pipelines API

The Pipelines API from TetraScience — 17 operation(s) for pipelines.

TetraScience Pipelines API is one of 35 APIs that TetraScience publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pipelines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 17 operations across 17 paths, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 5 base URLs: https://api.tetrascience.com, https://api.tetrascience-uat.com, https://api.tetrascience-dev.com, https://api.tetrascience-uat.com, api.tetrascience.com.

17 operations 17 paths 22 schemas 9 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api.tetrascience.com
Authentication
API Key, API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 3

TetraScience Pipelines API declares 3 security schemes for authenticating requests. An API key is passed in the header as ts-auth-token (token). An API key is passed in the header as x-org-slug (orgSlug). An API key is passed in the header as ts-auth-token (tsAuthToken). By default, every request must be authenticated.

  • token — JWT Token for authentication
  • orgSlug — Your organization slug

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 9 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Pipelines 17
POST
/v1/pipeline/{pipelineId}/create-pipeline-bulk-processing-job
Create a Bulk Processing Job
DL-FI-createBulkProcessJob 1 param body → 200400404409500
POST
/v1/pipeline/create
Create New Pipeline
DL-FI-createPipeline body → 200400
GET
/v1/pipeline/{pipelineId}
Get Details of a Single Pipeline
DL-FI-getPipeline 1 param → 200404
GET
/v1/pipeline/{pipelineId}/revisions/{revisionNumber}
Get Pipline Revision Contents
DL-FI-getRevision 2 params → 200400404
GET
/v1/pipeline/{pipelineId}/revisions
List Pipeline Revision History
DL-FI-getRevisions 3 params → 200400404
POST
/v1/pipeline/import
Import a Pipeline
DL-FI-importPipeline body → 200400
GET
/v1/pipeline/pipelines/id-only
List Pipeline IDs
DL-FI-listAllPipelineIds → 200
GET
/v1/pipeline/clusterPolicies/databricks
List Databricks Cluster Policies
DL-FI-listDatabricksClusterPolicies → 200400401500
GET
/v1/pipeline/clusters/databricks
List Databricks Clusters
DL-FI-listDatabricksClusters → 200401404
GET
/v1/pipeline/list
Paginate Through all Pipeline Details (Deprecated)
DL-FI-listPipelinesWithPagination 2 params → 200400
GET
/v1/pipeline/platform/info
Get Platform Information
DL-FI-platformInfo 1 param → 200400
POST
/v1/pipeline/process/{pipelineId}
Process List of Files with Pipeline
DL-FI-processPipeline 1 param body → 200400404
POST
/v1/pipeline/pipelines/{pipelineID}/reprocess
Process Files - draft
DL-FI-reprocess-files 1 param body → 200
POST
/v1/pipeline/rules-check
Get Count of Pipelines Accessible Via Access Rule
DL-FI-rulesCheck body → 200400401
GET
/v1/pipeline/search
Search Pipelines
DL-FI-search 14 params → 200400
POST
/v1/pipeline/{pipelineId}/status
Set Pipeline Status
DL-FI-setStatus 1 param body → 204400404
POST
/v1/pipeline/update/{pipelineId}
Update Existing Pipeline
DL-FI-updatePipeline 1 param body → 200400404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are PipelineSettings (22 properties), PipelineLabelFilter (5 properties), PipelineRevisionMetadata (5 properties), DatabricksClusterPolicy (3 properties). Each schema is shown below with its type and property counts.

PipelineNestedLabel
object
2 properties 2 required
PipelineFilterConfig
ScheduledTriggerOutputPipeline
PipelineConfig
object
PipelineLabelFilter
object
5 properties 3 required
FileTriggerOutputPipeline
FileTriggerInputPipeline
BasicPipelineInputObject
FilterAllowAllConfig
object
1 property 1 required
DatabricksClusterPolicy
object
3 properties 2 required
PipelineInputObject
PipelineRevision
PipelineSettings
object
22 properties 1 required
DatabricksClusterObject
object
2 properties
BasicPipelineOutputObject
ScheduledTriggerInputPipeline
PipelineRevisionMetadata
object
5 properties 5 required
StepsConfig
object
2 properties
PipelineAttributeRule
object
1 property 1 required
PipelineFilterLogicalConfig
object
3 properties 1 required
TriggerConditionGroup
object
3 properties 3 required
PipelineOutputObject

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-pipelines-api-openapi.yml Raw ↑

Other APIs TetraScience publishes across the network.

TetraScience Access Groups API
TetraScience Agents API
TetraScience ai-workflows API
TetraScience Attributes API
TetraScience Audit Trail API
TetraScience clusters API
TetraScience Commands API
TetraScience Connectors API
TetraScience Data Acquisition API
TetraScience Data App Providers API
TetraScience Data Apps API
TetraScience databricks API