Jump to Content
API Reference
Product Documentation
Home
Product Documentation
API Reference
v4.1
v4.2
v4.3
v4.4
API Reference
Product Documentation
Log In
API Reference
Log In
v4.3
API Reference
Pipeline and Workflow Objects and Parameters
All
Pages
Start typing to search…
JUMP TO
TetraScience API
Introduction
Authentication
Tetra Data Lake
Data Lake API Endpoints
Files
Delete a File
del
Retrieve a File
get
Upload a File
post
Get File Information
get
Get File Versions
get
Attributes
Retrieve metadata and tags of a file
get
Add metadata and tags to a file
post
Update metadata and tags to a file
put
Add Labels (POST)
post
Delete Labels (DELETE)
del
Schemas
List Schemas
get
Search
Search files via Elasticsearch Query Language
post
Search Files (GET) (Deprecated)
get
Search Files (POST) (Deprecated)
post
Logs
Query System Logs
get
Pipelines
Pipelines
Process Files - draft
post
/v1/pipeline/platform/info
get
/v1/pipeline/list
get
/v1/pipeline/{pipelineId}
get
/v1/pipeline/{pipelineId}/status
post
/v1/pipeline/{pipelineId}/revisions
get
/v1/pipeline/{pipelineId}/revisions/{revisionNumber}
get
/v1/pipeline/search
get
/v1/pipeline/create
post
/v1/pipeline/update/{pipelineId}
post
/v1/pipeline/process/{pipelineId}
post
/v1/pipeline/{pipelineId}/create-pipeline-bulk-processing-job
post
Workflows
Search Workflows (Deprecated)
get
Search Workflow
get
Status By Pipeline
get
Get Single Workflow Details
get
Search workflows draft
get
Pipeline Examples
Pipeline and Workflow Objects and Parameters
clusters
/v1/pipeline/clusters/databricks
get
Agents
Agents
Get agents
get
Create an agent
post
Get agent
get
Update an agent
put
Get command queue
get
Enable or disable command queue.
put
Enable or disable an agent
put
Change agent connector
put
Get File-Log agent configuration
get
Remotely configure a running File-Log agent
post
Deprecated - Get File-Log agent configuration
get
Deprecated - Remotely configure a running File-Log agent
post
Get File-Log agent configuration list
get
Data Acquisition
File Upload
post
Agent Log Upload
post
Agent System Metric Upload
post
Agent Status (Heart Beat)
post
Agent Status Setting Update
put
Agent Configuration
post
Agent Temp AWS Credentials
post
Commands
Command Service Endpoints
Purge queue
del
Search commands
get
Create command
post
Get one command
get
Get command history
get
List command actions
get
Hubs & Connectors
Hubs
Get all Hubs
get
Get a Hub by id
get
Connectors
Get all Connectors
get
Get a Connector by id
get
Get a Connector's reported files
get
Get statistics about a Connector's files
get
Get a Connector's metrics
get
Artifact Management Service
connectors
List all connectors artifacts
get
List all connectors artifacts of sub-type data-app
get
Search for items
post
Search for items
post
List all Connectors for namespace
get
List all Data Apps for namespace
get
Returns a list of Connector artifacts given a namespace and slug
get
Returns a list of Data App artifacts given a namespace and slug
get
Get single Connector
get
Get single Data App
get
Get artifacts related to Connector
get
Get labels for an Connector
get
Get available file slugs for Connector
get
Get contents for an Connector file
get
IDS
List all ids artifacts
get
Search for items
post
List all IDSes for namespace
get
Returns a list of IDS artifacts given a namespace and slug
get
Get single IDS
get
Get artifacts related to IDS
get
Get labels for an IDS
get
Get contents for an IDS file
get
Protocols
Get available file slugs for IDS
get
List all protocols
get
Search for items
post
List all protocols for namespace
get
List all protocols for namespace/slug
get
Get single protocol
get
Get related artifacts
get
Get labels for a protocol
get
Get available file slugs for protocol
get
Get contents for a protocol file
get
Get available file slugs for task-script
get
Task Scripts
List all task-scripts
get
Search for items
post
List all task-scripts for a namespace
get
List all task-scripts for a namespace/slug
get
Get single task-script
get
Get artifacts related to task-script
get
Get labels for a task-script
get
Get contents of a task-script file
get
tetraflows
List all tetraflow artifacts
get
Search for tetraflow artifacts
post
List all tetraflow for namespace
get
List all tetraflow for namespace/slug
get
Get a single tetraflow artifact
get
Get labels for a tetraflow
get
Get available file slugs for tetraflow
get
Get contents for a tetraflow file
get
lakehouse
List all lakehouse artifacts
get
Search for lakehouse artifacts
post
List all lakehouse for namespace
get
List all lakehouse for namespace/slug
get
Get a single lakehouse artifact
get
Get labels for a lakehouse
get
Get available file slugs for lakehouse
get
Get contents for a lakehouse file
get
Administration
Login
Get login config
get
Get login config (Subdomain based)
get
Login user
post
SSO login
get
SSO login (Subdomain based)
get
Send a password reset email to the user by email
post
Update expired password
put
Tenants
Get list of tenants
get
Create a new tenant.
post
Get tenant information
get
Update tenant information
put
Get all users in a tenant
get
Get all organizations in a tenant
get
Organizations
Get organization by ID
get
Update organization by ID
put
Get Users for Organization
get
Add a user to Organization
post
Delete user from organization
del
Users
Get current user details
get
Set default organization
post
Update current user's password
put
Get user by ID
get
Update user by ID
put
Unlock user
put
Update user status in the organization
put
Update a user's password
put
Get user roles in the organization matching the orgSlug
get
Add new roles for a user
post
Update the roles for a user
put
Create user token
post
Revoke user token
post
Roles
List all roles in an organization
get
Create a new role in an organization
post
Get role by ID
get
Update role by ID
put
Delete role by ID
del
Update SSO group mapping for role
put
Get all policies supported in the system
get
Get users with the role
get
Add / remove users to role
post
Access Groups
List Access Groups for an Organization
get
Create a New Access Group
post
Get Access Group Details
get
Edit an Access Group
put
Delete an Access Group
del
Add or Remove Users from an Access Group
post
Add a User to an Access Group
post
Remove a User from an Access Group
del
List Access Groups that a User Belongs To
get
Event Subscriptions API
View Subscriptions
Get a subscription by ID
get
Get subscriptions for your org
get
Edit Subscriptions
Request to create a new subscription
post
Request to delete a subscription
post
Get a list of all available event types for this org
get
Request to update a subscription
post
Requests
Delete a request by ID
del
Get a request by ID
get
Get recent requests
get
Audit service
Audit Trail
Get audit logs (Paginated)
get
Powered by
Pipeline and Workflow Objects and Parameters
Ask AI
