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 Connectors API

The Connectors API from TetraScience — 23 operation(s) for connectors.

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

Tagged areas include Connectors. 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 23 operations across 23 paths, and defines 28 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.

23 operations 23 paths 28 schemas 21 GET2 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 Connectors 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 23

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

Connectors 23
GET
/v1/data-acquisition/connectors
Get all Connectors
ConnectorController_getAll → 200
GET
/v1/data-acquisition/connectors/{id}
Get a Connector by id
ConnectorController_getById 3 params → 200
GET
/v1/data-acquisition/connectors/{id}/metrics
Get a Connector's metrics
ConnectorController_getFileMetrics 1 param → 200
GET
/v1/data-acquisition/connectors/{id}/files
Get a Connector's reported files
ConnectorController_getFiles 15 params → 200
GET
/v1/data-acquisition/connectors/{id}/files/stats
Get statistics about a Connector's files
ConnectorController_getFileStats 1 param → 200
GET
/v1/artifacts/connectors/{namespace}
List all Connectors for namespace
getConnectorArtifactByNamespace 3 params → 200404
GET
/v1/artifacts/connectors/{namespace}/{slug}
Returns a list of Connector artifacts given a namespace and slug
getConnectorArtifactByNamespaceAndSlug 4 params → 200404
GET
/v1/artifacts/connectors/{namespace}/{slug}/{version}/files/{fileSlug}
Get contents for an Connector file
getConnectorArtifactByNamespaceSlugAndFileSlug 6 params → 200400404
GET
/v1/artifacts/connectors/{namespace}/{slug}/{version}
Get single Connector
getConnectorArtifactByNamespaceSlugAndVersion 4 params → 200404
GET
/v1/artifacts/connectors/{namespace}/{slug}/{version}/files
Get available file slugs for Connector
getConnectorArtifactFileSlugs 4 params → 200400404
GET
/v1/artifacts/connectors/{namespace}/{slug}/{version}/labels
Get labels for an Connector
getConnectorArtifactLabels 4 params → 200404
GET
/v1/artifacts/connectors/{namespace}/{slug}/{version}/relationships
Get artifacts related to Connector
getConnectorArtifactRelationships 4 params → 200404
GET
/v1/artifacts/connectors
List all connectors artifacts
getConnectorArtifacts 3 params → 200
GET
/v1/artifacts/data-apps/{namespace}
List all Data Apps for namespace
getDataAppArtifactByNamespace 3 params → 200404
GET
/v1/artifacts/data-apps/{namespace}/{slug}
Returns a list of Data App artifacts given a namespace and slug
getDataAppArtifactByNamespaceAndSlug 4 params → 200404
GET
/v1/artifacts/data-apps/{namespace}/{slug}/{version}/files/{fileSlug}
Get contents for a Data App file
getDataAppArtifactByNamespaceSlugAndFileSlug 6 params → 200400404
GET
/v1/artifacts/data-apps/{namespace}/{slug}/{version}
Get single Data App
getDataAppArtifactByNamespaceSlugAndVersion 4 params → 200404
GET
/v1/artifacts/data-apps/{namespace}/{slug}/{version}/files
Get available file slugs for Data App
getDataAppArtifactFileSlugs 4 params → 200400404
GET
/v1/artifacts/data-apps/{namespace}/{slug}/{version}/labels
Get labels for a Data App
getDataAppArtifactLabels 4 params → 200404
GET
/v1/artifacts/data-apps/{namespace}/{slug}/{version}/relationships
Get artifacts related to Data App
getDataAppArtifactRelationships 4 params → 200404
GET
/v1/artifacts/data-apps
List all connectors artifacts of sub-type data-app
getDataAppArtifacts 3 params → 200404
POST
/v1/artifacts/connectors/search
Search for items
searchConnectors 3 params → 200
POST
/v1/artifacts/data-apps/search
Search for items
searchDataApps 3 params → 200404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are HubDto (29 properties), ConnectorDetailsDto (21 properties), ConnectorDto (20 properties), ConnectorFileDto (9 properties). Each schema is shown below with its type and property counts.

ArtifactDto
object
3 properties 4 required
ConnectorFilesResponse
object
A list of files reported by a Connector.
2 properties 2 required
Relationships
object
4 properties
GetConnectorFileStatsDto
object
The file stats reported by a Connector.
6 properties 6 required
MetricTimeValueDto
object
A metric time-value pair reported by a Connector.
2 properties 2 required
ConnectorCustomRouteUiComponentDto
object
4 properties 4 required
ConnectorCustomConfigUiComponentDto
object
3 properties 3 required
LabelList
array
HubStatusDto
object
5 properties 5 required
HubDto
object
29 properties 14 required
ConnectorObjectList
array
SupportedPlatformVersion
object
2 properties
HubHostDto
object
4 properties 4 required
ConnectorGeneratedConfigUiComponentDto
object
3 properties 3 required
ConnectorDetailsDto
object
Details of a single Connector.
21 properties 17 required
ArtifactNamespace
string
ConnectorsResponse
object
A list of Connectors
1 property 1 required
ConnectorObject
ConnectorFileDto
object
A file reported by a Connector.
9 properties 8 required
LabelDto
object
3 properties 3 required
ConnectorUiDto
object
1 property 1 required
ArtifactObjectBase
object
9 properties 5 required
Key
object
4 properties 4 required
GetConnectorMetricsDto
object
The set of metrics reported by the Connector.
1 property 1 required
ConnectorMetricDto
object
A set of metric values reported by a Connector.
2 properties 2 required
ArtifactDetailsDto
object
This is the detailed version of the ArtifactDto. Includes dynamic fields from the artifact's manifest, so not all response keys are listed here.
7 properties 8 required
ConnectorFileSlug
string
ConnectorDto
object
Details of a single Connector
20 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-connectors-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 Data Acquisition API
TetraScience Data App Providers API
TetraScience Data Apps API
TetraScience databricks API
TetraScience Edit Subscriptions API