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

The Agents API from TetraScience — 8 operation(s) for agents.

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

Tagged areas include Agents. 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 13 operations across 8 paths, and defines 3 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.

13 operations 8 paths 3 schemas 6 GET3 POST4 PUT

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 Agents 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 13

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

Agents 13
PUT
/v1/agents/{agentId}/command-queue
Enable or disable command queue.
agent-command-queue-enable 1 param body → 200400
GET
/v1/agents/{agentId}/command-queue
Get command queue
agent-command-queue-get 1 param → 200400404
POST
/v1/agents
Create an agent
agent-create body → 200400
GET
/v1/agents
Get agents
agents-get 1 param → 200
PUT
/v1/agents/{agentId}/enabled
Enable or disable an agent
agent-enable 1 param body → 200
GET
/v1/agents/{agentId}/configuration/list
Get File-Log agent configuration list
agent-get-configuration-list 6 params → 200
GET
/v1/agents/{agentId}/configuration
Get File-Log agent configuration
agent-get-configuration 2 params → 200
POST
/v1/agents/{agentId}/configuration
Remotely configure a running File-Log agent
agent-post-configuration 1 param body → 200400404
GET
/v1/agents/{agentId}
Get agent
agent-get 1 param → 200
PUT
/v1/agents/{agentId}
Update an agent
agent-update 1 param body → 200400
PUT
/v1/agents/{agentId}/connector
Change agent connector
agent-update-connector 1 param body → 200
GET
/v1/agents/{agentId}/configdeprecated
Deprecated - Get File-Log agent configuration
deprecated-agent-get-configuration 2 params → 200
POST
/v1/agents/{agentId}/configdeprecated
Deprecated - Remotely configure a running File-Log agent
deprecated-agent-post-configuration 1 param body → 200400404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are FLAFileWatcherPathConfigurationItem (12 properties), AgentConfiguration (6 properties), FLAConfiguration (5 properties). Each schema is shown below with its type and property counts.

FLAFileWatcherPathConfigurationItem
object
FLA v4.3.0+: Options for archival and deletion of files in the path after upload
12 properties 6 required
AgentConfiguration
object
6 properties
FLAConfiguration
object
Agent configuration if available, null otherwise.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-agents-api-openapi.yml Raw ↑

Other APIs TetraScience publishes across the network.

TetraScience Access Groups 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
TetraScience Edit Subscriptions API