{ "opencollection": "1.0.0", "info": { "name": "TetraScience Data and AI Cloud API", "version": "4.0" }, "request": { "auth": { "type": "apikey", "key": "ts-auth-token", "value": "{{ts-auth-token}}", "placement": "header" } }, "items": [ { "info": { "name": "Commands", "type": "folder" }, "items": [ { "info": { "name": "Search commands", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/commands", "params": [ { "name": "targetId", "value": "", "type": "query", "description": "ID of the target that received and processed command(s). Supports one or more values, such as `targetId=71003689-9619-43aa-809a-a693ede72e8b&targetId=740b1e83-eaf0-4e03-b134-97fb575a8c4c`" }, { "name": "action", "value": "", "type": "query", "description": "Action label, such as TetraScience.Connector.sdc.CreateMeasurementOrder. Supports one or more values, such as `action=TetraScience.Connector.sdc.CreateMeasurementOrder&action=TetraScience.Connector.ValidateConfig`" }, { "name": "status", "value": "", "type": "query", "description": "Command status: CREATED, UNSENT, PENDING, EXPIRED, PURGED, ERROR, PROCESSING, REJECTED, SUCCESS, FAILURE. Supports one or more values, such as `status=FAILURE&status=SUCCESS`" }, { "name": "fromDate", "value": "", "type": "query", "description": "Deprecated name for `createdAtAfter`" }, { "name": "toDate", "value": "", "type": "query", "description": "Deprecated name for `createdAtBefore`" }, { "name": "createdAtBefore", "value": "", "type": "query", "description": "Commands created on or before a given date (ISO timestamp)" }, { "name": "createdAtAfter", "value": "", "type": "query", "description": "Commands created on or after a given date (ISO timestamp)" }, { "name": "expiresAtBefore", "value": "", "type": "query", "description": "Commands expiring on or before a given date (ISO timestamp)" }, { "name": "expiresAtAfter", "value": "", "type": "query", "description": "Commands expiring on or after a given date (ISO timestamp)" }, { "name": "updatedAtBefore", "value": "", "type": "query", "description": "Commands updated on or before a given date (ISO timestamp)" }, { "name": "updatedAtAfter", "value": "", "type": "query", "description": "Commands updated on or after a given date (ISO timestamp)" }, { "name": "from", "value": "", "type": "query", "description": "Display commands started from specified number in the results array. By default, commands are displayed from the start of the array (the number 0). This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with size." }, { "name": "size", "value": "", "type": "query", "description": "Indicates the number of results to return in the request. This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with from." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort field: createdAt | updatedAt | expiresAt." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order: asc | desc" }, { "name": "metadata", "value": "", "type": "query", "description": "Metadata key-value pairs, such as metadata.vendor=tetra. Pairs must be exact matches of existing metadata values." } ] }, "docs": "Use this endpoint to search all on-premises commands based on various filters. This endpoint is useful when you want to filter out commands, get all successful, or unsuccessful commands, get all commands that are sent to some agent/connector, commands that are created within a certain time range and more." }, { "info": { "name": "Create command", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/commands", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new command for an on-premises connector/agent. It also automatically sends command to SQS queue for execution. Once it is in the queue, the connector/agent listening on the target queue picks up the command, tries to execute it, and sends the response back to the command service.\nThe maximum create command request size is 10 MB." }, { "info": { "name": "Purge queue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/commands", "params": [ { "name": "targetId", "value": "", "type": "query", "description": "Agent or connector ID for which queue should be purged" } ] }, "docs": "Use this method to purge all existing commands from the target queue. This command can be useful when testing new pipelines and command creation and the queue is blocked by a large number of unexecuted commands. When you fire this endpoint, all commands are deleted from the queue, and the command status is changed to PURGED. Also, during the purge, the queue for the given target is blocked and does not receive new commands." }, { "info": { "name": "Get command history", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/commands/:id/history", "params": [ { "name": "id", "value": "", "type": "path", "description": "Command id" } ] }, "docs": "Use this endpoint to obtain all the changes of a given command. It should return all status changes including who made the change and when the change was made." }, { "info": { "name": "Get one command", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/commands/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Command ID" } ] }, "docs": "Use this endpoint to obtain all the details for one single command. You will need to supply the command id as the path variable. This endpoint returns details like the command id, creation time, expiration time, the action, actual request body, and more." }, { "info": { "name": "List command actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/commands/actions" }, "docs": "Use this endpoint to list all distinct on-premises command actions.\n\nNote that this API does not control command actions, so this result may contain erroneous or unsent actions." } ] }, { "info": { "name": "Agents", "type": "folder" }, "items": [ { "info": { "name": "Get command queue", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/agents/:agentId/command-queue", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent" } ] }, "docs": "Use this endpoint to get details about the command queue of an agent" }, { "info": { "name": "Enable or disable command queue.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/agents/:agentId/command-queue", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to enable or disable the command queue of an agent." }, { "info": { "name": "Get agents", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/agents", "params": [ { "name": "include", "value": "labels", "type": "query", "description": "Each agent returned will include its associated labels when the value is 'labels'. Otherwise this parameter is ignored" } ] }, "docs": "Use this endpoint to get a list of agents." }, { "info": { "name": "Create an agent", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/agents", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new agent." }, { "info": { "name": "Enable or disable an agent", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/agents/:agentId/enabled", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to enable or disable an agent" }, { "info": { "name": "Get File-Log agent configuration list", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/agents/:agentId/configuration/list", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "by", "value": "", "type": "query", "description": "Filter by agent config type" }, { "name": "status", "value": "", "type": "query", "description": "Filter by agent config by its command status" }, { "name": "order", "value": "", "type": "query", "description": "Sorting order by creation date" } ] }, "docs": "Use this endpoint to get the past configurations of a File-Log agent" }, { "info": { "name": "Get File-Log agent configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/agents/:agentId/configuration", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID" }, { "name": "type", "value": "", "type": "query", "description": "Type of the configuration to be returned, 'cloud' or 'local'. If the parameter is not provided, The endpoint will default to 'local' type." } ] }, "docs": "Use this endpoint to get the latest configuration, of the type requested, of a File Log Agent" }, { "info": { "name": "Remotely configure a running File-Log agent", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/agents/:agentId/configuration", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "-| This endpoint allows configuration of a running File-Log Agent with paths. The File-Log Agent must be version 4.1.0 or greater, and configured to Receive Commands. Additionally, the Command Queue must be enabled for this Agent on TDP.\nThis will remove any paths not included in the JSON. To preserve existing paths, you must include them each time you POST.\nIf the target's command queue doesn't exist or is not accessible, the API will return a 400 error code and doesn't create the command.\nFor" }, { "info": { "name": "Get agent", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/agents/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent." } ] }, "docs": "Use this endpoint to get the details of a single agent." }, { "info": { "name": "Update an agent", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/agents/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a single agent" }, { "info": { "name": "Change agent connector", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/agents/:agentId/connector", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to change the connector of an agent" }, { "info": { "name": "Deprecated - Get File-Log agent configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/agents/:agentId/config", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID" }, { "name": "type", "value": "", "type": "query", "description": "Type of the configuration to be returned, 'cloud' or 'local'. If this parameter is not provided, the endpoint will default to 'local'." } ] }, "docs": "This endpoint has been deprecated in favor of /v1/agents/{agentId}/configuration. Both endpoints are identical." }, { "info": { "name": "Deprecated - Remotely configure a running File-Log agent", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/agents/:agentId/config", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "-| This endpoint has been deprecated in favor of /v1/agents/{agentId}/configuration. Both endpoints are identical." } ] }, { "info": { "name": "Data Acquisition", "type": "folder" }, "items": [ { "info": { "name": "Agent Temp AWS Credentials", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/credentials", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint returns temporary credentials for a given organization based on Data Hub policy. When using those credentials, client can upload files to their Amazon S3 bucket and write log to Amazon CloudWatch. Returned credentials have expiration time 60 minutes." }, { "info": { "name": "Agent Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/config", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint returns all the parameters that client needs in order to upload files directly to Amazon S3 and upload log directly to Amazon CloudWatch. Using these values and temporary credentials obtained from `/v1/data-acquisition/agent/credentials` client can upload files to S3 into their bucket and log to CloudWatch into their log groups." }, { "info": { "name": "Agent Status (Heart Beat)", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/status", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows TetraScience Agent to send heartbeats to the Tetrascience platform periodically. Platform will return the agent's name. It's recommended to send a heartbeat every 30 seconds.\n\nIt requires a user-defined agent set up in the TetraScience Web UI.\n\nRequired fields:\n- agentId\n- agentVersion\n\nOptional fields:\n- agent\n- sourceType - If agent defines various source types, like file-log agent, this should be an array of objects with `filePath` and `type` values. Otherwise, it should " }, { "info": { "name": "Agent Status Setting Update", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/status", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows TetraScience Agent to send status setting update to platform. Tetrascience agents have start/stop button. When start button is clicked, agent should hit endpoint with `statusSetting=STARTED`. Opposite, when stop button is clicked, agent should hit endpoint with `statusSetting=STOPPED`.\n\n It requires a user-defined agent set up in the TetraScience Web UI" }, { "info": { "name": "Agent System Metric Upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/systemmetric", "body": { "type": "multipart-form", "data": [ { "name": "agentId", "type": "text", "value": "" }, { "name": "agentVersion", "type": "text", "value": "" }, { "name": "systemmetric", "type": "text", "value": "" } ] } }, "docs": "TetraScience Agent can periodically upload system metrics of itself and the host environment the Agent is running. It requires a user-defined agent set up in the TetraScience Web UI. Uploaded system metric file should be new line delimited JSON file. See below for more details." }, { "info": { "name": "File Upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/upload", "body": { "type": "multipart-form", "data": [ { "name": "agentId", "type": "text", "value": "" }, { "name": "agent", "type": "text", "value": "" }, { "name": "agentVersion", "type": "text", "value": "" }, { "name": "sourceType", "type": "text", "value": "" }, { "name": "fileCategory", "type": "text", "value": "" }, { "name": "fileId", "type": "text", "value": "" }, { "name": "traceId", "type": "text", "value": "" }, { "name": "filePath", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" }, { "name": "payloadGzip", "type": "text", "value": "" }, { "name": "metadata", "type": "text", "value": "" }, { "name": "tags", "type": "text", "value": "" }, { "name": "labels", "type": "text", "value": "" } ] } }, "docs": "This endpoint uploads a file to TetraScience Cloud. It requires a user-defined agent set up in the TetraScience Web UI. API users can use it to upload, manage their files, and trigger pipelines.\n\n\nMaximum payload size: 500MB\n\nValidations performed by this endpoint:\n\n1. `agentId` must be a valid ID of the user defined agent (UDA)\n2. param `sourceType` must contain only lower case alphanumerical characters and dashes\n3. params `metadata` and `tags` must contain only ASCII characters; `tags` valu" }, { "info": { "name": "Agent Log Upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/data-acquisition/agent/log", "body": { "type": "multipart-form", "data": [ { "name": "agentId", "type": "text", "value": "" }, { "name": "agentVersion", "type": "text", "value": "" }, { "name": "log", "type": "text", "value": "" } ] } }, "docs": "This endpoint uploads agents log to TetraScience Cloud. It requires a user-defined agent set up in the TetraScience Web UI." } ] }, { "info": { "name": "Data Apps", "type": "folder" }, "items": [ { "info": { "name": "Check how many data apps match the provided access control rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/dataapps/rules-check", "body": { "type": "json", "data": "{}" } }, "docs": "Check how many data apps match the provided access control rules" }, { "info": { "name": "Clear the selected data app and auth cookies", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/dataapps/apps/container/cookies" }, "docs": "Clear the selected data app and auth cookies" }, { "info": { "name": "Fetch connector key value by key for a data app", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/kv/:appSlug/:key", "params": [ { "name": "appSlug", "value": "", "type": "path" }, { "name": "artifact_type", "value": "", "type": "query", "description": "Required artifact type filter used during authorization and app lookup." }, { "name": "namespace", "value": "", "type": "query", "description": "Required artifact namespace filter used during authorization and app lookup." }, { "name": "key", "value": "", "type": "path", "description": "Connector key. Commas are not allowed." } ] }, "docs": "Fetch connector key value by key for a data app" }, { "info": { "name": "Delete connector key value by key for a data app", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/dataapps/kv/:appSlug/:key", "params": [ { "name": "appSlug", "value": "", "type": "path" }, { "name": "artifact_type", "value": "", "type": "query", "description": "Required artifact type filter used during authorization and app lookup." }, { "name": "namespace", "value": "", "type": "query", "description": "Required artifact namespace filter used during authorization and app lookup." }, { "name": "key", "value": "", "type": "path", "description": "Connector key. Commas are not allowed." } ] }, "docs": "Delete connector key value by key for a data app" }, { "info": { "name": "Download container logs for a specific data app", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/apps/:id/logs/download", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "since", "value": "", "type": "query", "description": "Relative time range for logs (30s, 10m, 30m, 1h, 12h, 1d, 3d, 1w for download)" } ] }, "docs": "Download container logs for a specific data app" }, { "info": { "name": "Execute a DML query on external or lakehouse schemas", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/dataapps/data/executeDML", "body": { "type": "json", "data": "{}" } }, "docs": "Execute a DML query on external or lakehouse schemas" }, { "info": { "name": "List installed Data Apps", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/apps", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination (starts from 1)" }, { "name": "includeLabels", "value": "", "type": "query", "description": "Include labels for each data app" }, { "name": "labelKey", "value": "", "type": "query", "description": "Filter data apps by label key" }, { "name": "labelValue", "value": "", "type": "query", "description": "Filter data apps by label value (requires labelKey)" }, { "name": "type", "value": "", "type": "query", "description": "Filter data apps by type (CONNECTED or CONTAINER)" }, { "name": "search", "value": "", "type": "query", "description": "Search term to filter data apps by name, description, or slug" }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort results by" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction (asc or desc)" } ] }, "docs": "Retrieves a paginated list of Data Apps currently installed in your organization. Supports filtering by type, labels, and search term." }, { "info": { "name": "Fetch container data app by connector or data app ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/apps/container/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch container data app by connector or data app ID" }, { "info": { "name": "Fetch container logs for a specific data app", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/apps/:id/logs", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "mode", "value": "", "type": "query", "description": "Log fetch mode: \"time\" for time-based, \"count\" for last N messages" }, { "name": "since", "value": "", "type": "query", "description": "Relative time range for logs (30s, 10m, 30m, 1h, 12h, 1d, 3d, 1w). Used when mode=time" }, { "name": "count", "value": "", "type": "query", "description": "Number of most recent log messages to return. Used when mode=count" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log events per request (for pagination)" }, { "name": "nextToken", "value": "", "type": "query", "description": "Token for pagination" } ] }, "docs": "Fetch container logs for a specific data app" }, { "info": { "name": "Get Data App details", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/apps/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Data App ID" } ] }, "docs": "Retrieves complete details of a single installed Data App, including metadata, deployment configuration, platform requirements, assigned labels, and associated providers." }, { "info": { "name": "Fetch next chunk for an executed DML statement", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/data/fetchDMLResult", "params": [ { "name": "statementId", "value": "", "type": "query" }, { "name": "chunkIndex", "value": "", "type": "query" } ] }, "docs": "Fetch next chunk for an executed DML statement" }, { "info": { "name": "List connector key value keys for a data app", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/kv/:appSlug", "params": [ { "name": "appSlug", "value": "", "type": "path" }, { "name": "artifact_type", "value": "", "type": "query", "description": "Required artifact type filter used during authorization and app lookup." }, { "name": "namespace", "value": "", "type": "query", "description": "Required artifact namespace filter used during authorization and app lookup." } ] }, "docs": "List connector key value keys for a data app" }, { "info": { "name": "Save connector key values for a data app", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/dataapps/kv/:appSlug", "params": [ { "name": "appSlug", "value": "", "type": "path" }, { "name": "artifact_type", "value": "", "type": "query", "description": "Required artifact type filter used during authorization and app lookup." }, { "name": "namespace", "value": "", "type": "query", "description": "Required artifact namespace filter used during authorization and app lookup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Save connector key values for a data app" }, { "info": { "name": "Update Data App labels for access control", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/dataapps/apps/:id/labels", "params": [ { "name": "id", "value": "", "type": "path", "description": "Data App ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all labels assigned to a Data App. Labels drive EARS (Entitlement and Access Rights Service) access control policies — use them to control which users and teams can see and interact with a Data App. Pass an empty array to clear all labels." } ] }, { "info": { "name": "Connectors", "type": "folder" }, "items": [ { "info": { "name": "Get all Connectors", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/data-acquisition/connectors" }, "docs": "**:warning: This is a new API which is still subject to change.**\n\nUse this endpoint to get a list of Connectors." }, { "info": { "name": "Get a Connector by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/data-acquisition/connectors/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The Connector's id." }, { "name": "resolveSecrets", "value": "", "type": "query", "description": "If true, resolves secrets in the Connector's config. Requires organization admin permissions." }, { "name": "include", "value": "config", "type": "query", "description": "Include additional Connector fields. 'config' includes the Connector's config. 'artifact' includes the Connector artifact's details." } ] }, "docs": "**:warning: This is a new API which is still subject to change.**\n\nUse this endpoint to get a Connector's details by id." }, { "info": { "name": "Get a Connector's metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/data-acquisition/connectors/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "The Connector's id." } ] }, "docs": "**:warning: This is a new API which is still subject to change.**\n\nUse this endpoint to get the metrics reported by a Connector, including resource usage and file upload and error rates." }, { "info": { "name": "Get a Connector's reported files", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/data-acquisition/connectors/:id/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "The Connector's id." }, { "name": "fileIds", "value": "", "type": "query", "description": "A list of file ids to filter by." }, { "name": "excludeFileIds", "value": "", "type": "query", "description": "A list of file ids to exclude from the response." }, { "name": "uniqueExternalIds", "value": "", "type": "query", "description": "A list of unique external ids to filter by. Used by Connectors to deduplicate external files." }, { "name": "excludeUniqueExternalIds", "value": "", "type": "query", "description": "A list of unique external ids to exclude from the response. Used by Connectors to deduplicate external files." }, { "name": "statuses", "value": "", "type": "query", "description": "A list of file statuses to filter by." }, { "name": "maxErrors", "value": "", "type": "query", "description": "The maximum number of errors to filter by. Used by Connectors to limit file upload retries." }, { "name": "createdBefore", "value": "", "type": "query", "description": "The maximum creation date to filter by." }, { "name": "createdAfter", "value": "", "type": "query", "description": "The minimum creation date to filter by." }, { "name": "updatedBefore", "value": "", "type": "query", "description": "The maximum update date to filter by." }, { "name": "updatedAfter", "value": "", "type": "query", "description": "The minimum update date to filter by." }, { "name": "orderBy", "value": "", "type": "query", "description": "The field to order by." }, { "name": "orderDirection", "value": "", "type": "query", "description": "The order direction." }, { "name": "take", "value": "", "type": "query", "description": "The number of files to take. Default is 50." }, { "name": "skip", "value": "", "type": "query", "description": "The number of files to skip." } ] }, "docs": "**:warning: This is a new API which is still subject to change.**\n\nUse this endpoint to get metadata about the files reported by a Connector, including those that have not yet been uploaded or that have failed." }, { "info": { "name": "Get statistics about a Connector's files", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/data-acquisition/connectors/:id/files/stats", "params": [ { "name": "id", "value": "", "type": "path", "description": "The Connector's id." } ] }, "docs": "**:warning: This is a new API which is still subject to change.**\n\nUse this endpoint to get the file statistics reported by a Connector, including the total number of files and the number of files in each status." } ] }, { "info": { "name": "Data App Providers", "type": "folder" }, "items": [ { "info": { "name": "Fetch all data app providers", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/providers", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination (starts from 1)" }, { "name": "providerName", "value": "", "type": "query", "description": "The name of the provider to filter on" }, { "name": "orgId", "value": "", "type": "query" }, { "name": "includeArn", "value": "", "type": "query", "description": "Indicate if the secret ARNs should be included in the response" } ] }, "docs": "Fetch all data app providers" }, { "info": { "name": "Create a new Data App Provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/dataapps/providers", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Data App Provider" }, { "info": { "name": "Fetch a Data App Provider", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/providers/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "", "type": "query" }, { "name": "includeArn", "value": "", "type": "query" } ] }, "docs": "Fetch a Data App Provider" }, { "info": { "name": "Update a Data App Provider", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/dataapps/providers/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Data App Provider" }, { "info": { "name": "Delete a Data App Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/dataapps/providers/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Data App Provider" }, { "info": { "name": "Fetch all data app provider templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/providers/templates" }, "docs": "Fetch all data app provider templates" } ] }, { "info": { "name": "Linked Data Apps", "type": "folder" }, "items": [ { "info": { "name": "Create Linked Data App", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/dataapps/apps/linked", "body": { "type": "json", "data": "{}" } }, "docs": "Create Linked Data App" }, { "info": { "name": "Update Linked Data App", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/dataapps/apps/linked/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Linked Data App" }, { "info": { "name": "Delete Linked Data App", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/dataapps/apps/linked/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete Linked Data App" } ] }, { "info": { "name": "Embedded Data Apps", "type": "folder" }, "items": [ { "info": { "name": "List available Data Apps for installation", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/dataapps/apps/manage", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination (starts from 1)" }, { "name": "search", "value": "", "type": "query", "description": "Search term to filter data apps by name or slug" } ] }, "docs": "Retrieves the catalog of Data Apps available for installation in your organization, including their current installation status. Use this as the discovery endpoint for automated governance workflows — browse available apps and check requirements before installing." }, { "info": { "name": "Install, update, or uninstall Data Apps", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/dataapps/apps/manage", "body": { "type": "json", "data": "{}" } }, "docs": "Perform one or more install, update, or uninstall operations on embedded Data Apps. Submit an array of operations to manage which Data Apps are enabled in your organization. This endpoint supports automated governance workflows from CI/CD pipelines, GitHub Actions, or ServiceNow." } ] }, { "info": { "name": "Edit Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Request to create a new subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/externalevents/requests/creation", "body": { "type": "json", "data": "{}" } }, "docs": "Request to create a new subscription" }, { "info": { "name": "Request to delete a subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/externalevents/requests/deletion", "body": { "type": "json", "data": "{}" } }, "docs": "Request to delete a subscription" }, { "info": { "name": "Get a list of all available event types for this org", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/externalevents/availableEventTypes" }, "docs": "Get a list of all available event types for this org" }, { "info": { "name": "Request to update a subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/externalevents/requests/update", "body": { "type": "json", "data": "{}" } }, "docs": "Request to update a subscription" } ] }, { "info": { "name": "Access Groups", "type": "folder" }, "items": [ { "info": { "name": "Get Access Group Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/accessGroups/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the details of a specific [access group](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization)." }, { "info": { "name": "Edit an Access Group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/accessGroups/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit an [access group's](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization) name, description, status, and [data access rules](https://developers.tetrascience.com/docs/managing-organization-details#create-access-groups)." }, { "info": { "name": "Delete an Access Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/accessGroups/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an [access group](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization)." }, { "info": { "name": "Remove a User from an Access Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/accessGroups/:id/user/:userId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Remove a user from an [access group](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization)." }, { "info": { "name": "List Access Groups for an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/accessGroups" }, "docs": "Get a list of all [access groups](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization) for an organization." }, { "info": { "name": "Create a New Access Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/accessGroups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new [access group](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization)." }, { "info": { "name": "List Access Groups that a User Belongs To", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/accessGroups/user/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of all [access groups](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization) that a user belongs to." }, { "info": { "name": "Add a User to an Access Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/accessGroups/:id/user", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to an [access group](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization)." }, { "info": { "name": "Add or Remove Users from an Access Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/accessGroups/:id/users", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or remove users from an [access group](https://developers.tetrascience.com/docs/managing-organization-details#configure-data-access-rules-for-an-organization)." } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "Delete user from organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/organizations/:organizationId/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Remove a user from the organization, revoking all access and permissions. User account data and audit trails are preserved for compliance purposes." }, { "info": { "name": "Get Users for Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/organizations/:organizationId/users", "params": [ { "name": "userStatus", "value": "", "type": "query" }, { "name": "role", "value": "", "type": "query" }, { "name": "roleId", "value": "", "type": "query" }, { "name": "authType", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "email", "value": "", "type": "query", "description": "Email address of the user (exact match)" }, { "name": "firstName", "value": "", "type": "query", "description": "Exact match on user first name" }, { "name": "lastName", "value": "", "type": "query", "description": "Exact match on user last name" }, { "name": "include", "value": "", "type": "query" }, { "name": "withCredentials", "value": "", "type": "query" } ] }, "docs": "List all users within an organization including their roles, status, last activity, and access permissions for administrative oversight." }, { "info": { "name": "Add a user to Organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/organizations/:organizationId/users", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new user to the organization or invite existing users. Assigns default roles and sends invitation emails as configured." }, { "info": { "name": "Get organization by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path" } ] }, "docs": "Retrieve organization details including settings, features, subdomain, and administrative configuration for management purposes." }, { "info": { "name": "Update organization by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/organizations/:organizationId", "body": { "type": "json", "data": "{}" } }, "docs": "Update organization properties including name, description, logo, authentication type, email domain, and feature settings. Requires organization or system admin privileges." } ] }, { "info": { "name": "Roles", "type": "folder" }, "items": [ { "info": { "name": "Get role by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/roles/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path" } ] }, "docs": "Get role by ID" }, { "info": { "name": "Update role by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/roles/:roleId", "body": { "type": "json", "data": "{}" } }, "docs": "Update role by ID" }, { "info": { "name": "Delete role by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/roles/:roleId" }, "docs": "Delete role by ID" }, { "info": { "name": "Get all policies supported in the system", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/roles/policies" }, "docs": "Get all policies supported in the system" }, { "info": { "name": "Get users with the role", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/roles/:roleId/users", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get users with the role" }, { "info": { "name": "Add / remove users to role", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/roles/:roleId/users", "body": { "type": "json", "data": "{}" } }, "docs": "Add / remove users to role" }, { "info": { "name": "List all roles in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/roles" }, "docs": "List all roles in an organization" }, { "info": { "name": "Create a new role in an organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/roles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new role in an organization" }, { "info": { "name": "Update SSO group mapping for role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/roles/:roleId/ssoMapping", "body": { "type": "json", "data": "{}" } }, "docs": "Update SSO group mapping for role" } ] }, { "info": { "name": "Requests", "type": "folder" }, "items": [ { "info": { "name": "Get a request by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/externalevents/requests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "ID of the request" } ] }, "docs": "Get a request by ID" }, { "info": { "name": "Delete a request by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/externalevents/requests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "ID of the request" } ] }, "docs": "Delete a request by ID" }, { "info": { "name": "Get recent requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/externalevents/requests" }, "docs": "Get recent requests" } ] }, { "info": { "name": "Attributes", "type": "folder" }, "items": [ { "info": { "name": "Add Labels (POST)", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/fileinfo/files/:fileId/labels", "headers": [ { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "ID assigned to the file when it was created in the data lake. Type is uuid." }, { "name": "noPropagate", "value": "", "type": "query", "description": "Prevents label operation from triggering pipelines." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add custom labels to a file for categorization, organization, and enhanced searchability within the Data Lake. Use this endpoint when you need to tag files for better organization and filtering." }, { "info": { "name": "Delete Labels (DELETE)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/fileinfo/files/:fileId/labels", "headers": [ { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "ID assigned to the file when it was created in the data lake. Type is uuid." }, { "name": "labelId", "value": "", "type": "query", "description": "ID Assigned to the Label. You can find this by running the Get File Information endpoint: https://developers.tetrascience.com/reference/get-file-information" }, { "name": "noPropagate", "value": "", "type": "query", "description": "Prevents label operation from triggering pipelines." } ] }, "docs": "Remove specific labels from a file to either update categorization or correct labeling mistakes. Use this endpoint when you need to clean up incorrect labels or reorganize file categorization." }, { "info": { "name": "Retrieve metadata and tags of a file", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/datalake/metadata-tags", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "query", "description": "UUIDv4 of the target file in datalake" }, { "name": "bucket", "value": "", "type": "query", "description": "S3 bucket of the target file in datalake" }, { "name": "fileKey", "value": "", "type": "query", "description": "S3 key of the target file in datalake" }, { "name": "type", "value": "", "type": "query" }, { "name": "version", "value": "", "type": "query", "description": "Version of the target file in datalake" } ] }, "docs": "This endpoint returns metadata and tags of a target file in datalake. This endpoint require either `fileId` or `bucket`, `fileKey` and `version` to be provided in order to uniquely identify file.\n\nValidations performed by this endpoint:\n\n1. if parameter `fileId` is not provided, then `bucket, `fileKey` and `version` parameters must be provided\n2. if parameters `bucket`, `fileKey` and `version` are not provided, parameter `fileId` must be provided" }, { "info": { "name": "Add metadata and tags to a file", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/datalake/metadata-tags", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint appends tags to a target file in the datalake or modifies the value of a metadata key. This endpoint requires either `fileId` or `bucket`, `fileKey` and `version` to be provided in order to uniquely identify a file.\n**Note:** Applying metadata or tags to files larger than 5 GB isn't supported and will return a `500` error. For large files, you should [apply labels](https://developers.tetrascience.com/reference/dl-fi-add-labels) instead. This limitation is because of a hard limit on" }, { "info": { "name": "Update metadata and tags to a file", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tetrascience.com/v1/datalake/metadata-tags", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint replaces metadata and tags to a target file in the datalake. This endpoint require either `fileId` or `bucket`, `fileKey` and `version` to be provided in order to uniquely identify file.\n\nTarget file query is determined by field `originalFile`. Target file is queried in two ways:\n1. by `fileId` (UUID of a file in datalake)\n2. by `bucket`, `fileKey` and `version`\n\nEndpoint finds target file by given file query and creates new version with updated metadata and tags. If payload doesn'" } ] }, { "info": { "name": "Pipelines", "type": "folder" }, "items": [ { "info": { "name": "Create a Bulk Processing Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/:pipelineId/create-pipeline-bulk-processing-job", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Bulk Processing Job" }, { "info": { "name": "Create New Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create New Pipeline" }, { "info": { "name": "Get Details of a Single Pipeline", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/:pipelineId", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" } ] }, "docs": "Search data pipeline workflows" }, { "info": { "name": "Get Pipline Revision Contents", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/:pipelineId/revisions/:revisionNumber", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" }, { "name": "revisionNumber", "value": "", "type": "path", "description": "The number of the revision to get" } ] }, "docs": "Get Pipline Revision Contents" }, { "info": { "name": "List Pipeline Revision History", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/:pipelineId/revisions", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Defaults to 30" }, { "name": "cursor", "value": "", "type": "query", "description": "The first element in the dataset to query from. The cursor is a revision number" } ] }, "docs": "List Pipeline Revision History" }, { "info": { "name": "Import a Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/import", "body": { "type": "json", "data": "{}" } }, "docs": "Import a Pipeline" }, { "info": { "name": "List Pipeline IDs", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/pipelines/id-only" }, "docs": "List Pipeline IDs" }, { "info": { "name": "Paginate Through all Pipeline Details (Deprecated)", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/list", "params": [ { "name": "size", "value": "", "type": "query", "description": "Number of pipelines to return" }, { "name": "from", "value": "", "type": "query", "description": "Page number to start from (0-indexed)" } ] }, "docs": "Lists all of the pipelines in a paginated list" }, { "info": { "name": "Get Platform Information", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/platform/info", "params": [ { "name": "groups", "value": "", "type": "query", "description": "Groups from which platform information should be retrieved" } ] }, "docs": "Get information about the current platform deployment. May be useful for the platform UI." }, { "info": { "name": "Process List of Files with Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/process/:pipelineId", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint processes a list of files by using a specified pipeline. It processes the latest version of each file only." }, { "info": { "name": "Process Files - draft", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/pipelines/:pipelineID/reprocess", "params": [ { "name": "pipelineID", "value": "", "type": "path", "description": "Pipeline UUID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search data pipeline workflows" }, { "info": { "name": "Get Count of Pipelines Accessible Via Access Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/rules-check", "body": { "type": "json", "data": "{}" } }, "docs": "Get Count of Pipelines Accessible Via Access Rule" }, { "info": { "name": "Search Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/pipeline/search", "params": [ { "name": "size", "value": "", "type": "query", "description": "Number of pipelines to return" }, { "name": "from", "value": "", "type": "query", "description": "Page number to start from (0-indexed)" }, { "name": "pipelineStatus", "value": "", "type": "query", "description": "Status" }, { "name": "pipelineNameOrId", "value": "", "type": "query", "description": "Name or ID" }, { "name": "artifactType", "value": "", "type": "query", "description": "Tetraflow or Protocol" }, { "name": "protocolNamespace", "value": "", "type": "query", "description": "Namespace of protocol" }, { "name": "protocolName", "value": "", "type": "query", "description": "Name of protocol" }, { "name": "protocolVersion", "value": "", "type": "query", "description": "Version of protocol" }, { "name": "startTime", "value": "", "type": "query", "description": "Time when pipeline started" }, { "name": "endTime", "value": "", "type": "query", "description": "Time when pipeline ended" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field to sort results by" }, { "name": "order", "value": "", "type": "query", "description": "Ordering of" }, { "name": "labelKey", "value": "", "type": "query", "description": "Filter pipelines by label key. If provided, response contains pipelines with assigned matching label keys." }, { "name": "labelValue", "value": "", "type": "query", "description": "Filter pipelines by label value. Requires labelKey to be provided. If both labelKey and labelValue are provided, response contains pipelines with assigned matching key-value label pairs." } ] }, "docs": "Search pipelines" }, { "info": { "name": "Set Pipeline Status", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/:pipelineId/status", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Pipeline Status" }, { "info": { "name": "Update Existing Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/pipeline/update/:pipelineId", "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The ID of the pipeline" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Existing Pipeline" } ] }, { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Delete a File", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tetrascience.com/v1/datalake/delete", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "query", "description": "ID of the file to delete." } ] }, "docs": "This endpoint does soft delete. Soft delete means that file will remain in datalake but will be marked as deleted. This means that file will not appear in file search and Athena search" }, { "info": { "name": "Retrieve a File", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/datalake/retrieve", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "query", "description": "ID of the file to retrieve." }, { "name": "getPresigned", "value": "", "type": "query", "description": "A JSON object with temporary s3 url will returned instead of the actual file content (expires in 5 minutes)" } ] }, "docs": "This endpoint retrieves a specific file." }, { "info": { "name": "Upload a File", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/datalake/upload", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint uploads a file to the Data Lake.\nThe maximum upload request size is 200 MB." }, { "info": { "name": "Get File Information", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/fileinfo/file/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "ID assigned to the file when it was created in the data lake. Type is uuid." } ] }, "docs": "Get detailed information about a specific file, including its metadata, storage location, source, and integration details." }, { "info": { "name": "Get File Versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/fileinfo/file/:fileId/versions", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "ID assigned to the file when it was created in the data lake. Type is uuid." } ] }, "docs": "Retrieve a file's version history, including all modifications, updates, and processing iterations. Timestamps and change details are included." } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "Query System Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/datalake/queryActivityLog", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "queryId", "value": "", "type": "query", "description": "Query ID to retrieve more logs" }, { "name": "max", "value": "", "type": "query", "description": "Maximum number of logs to return" }, { "name": "next", "value": "", "type": "query", "description": "Next page token" }, { "name": "take", "value": "", "type": "query", "description": "Number of logs to take" }, { "name": "skip", "value": "", "type": "query", "description": "Number of logs to skip" }, { "name": "actor", "value": "", "type": "query", "description": "Filter by actor name (case-insensitive partial match)" }, { "name": "targetType", "value": "", "type": "query", "description": "Filter by target type (exact match)" }, { "name": "targetName", "value": "", "type": "query", "description": "Filter by target name (case-insensitive partial match)" }, { "name": "action", "value": "", "type": "query", "description": "Filter by single action type" }, { "name": "actions", "value": "", "type": "query", "description": "Filter by multiple action types (comma-separated)" }, { "name": "from", "value": "", "type": "query", "description": "Filter logs after this timestamp (ISO format)" }, { "name": "to", "value": "", "type": "query", "description": "Filter logs before this timestamp (ISO format)" }, { "name": "ids", "value": "", "type": "query", "description": "Filter by array of IDs" }, { "name": "id", "value": "", "type": "query", "description": "Filter by target ID (case-insensitive partial match)" }, { "name": "changeReason", "value": "", "type": "query", "description": "Filter by change reason (case-insensitive partial match)" }, { "name": "targetIds", "value": "", "type": "query", "description": "Filter by multiple target IDs (comma-separated)" }, { "name": "format", "value": "", "type": "query", "description": "Format of the response (use \"csv\" to download a CSV file)" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Order of sorting by timestamp (\"asc\" for ASC, DESC by default)" } ] }, "docs": "This endpoint retrieves System Logs for user activity in the Data Lake. You can query logs based on various parameters to track user actions or file operations and changes." } ] }, { "info": { "name": "Schemas", "type": "folder" }, "items": [ { "info": { "name": "List Schemas", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/datalake/schemas", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "query", "description": "Return only IDS of a given type. Example: `plate-reader`. If omitted, will return the all the IDS the api key has access to." }, { "name": "version", "value": "", "type": "query", "description": "Return a specific version. This must be used with `type`. Example: `v1.0.0`. If omitted, will return all the versions." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to return (nested paths are also supported). Example: `namespace,slug,version,schema.description`. If omitted, will return full structure. Not-existing fields will be ignored." } ] }, "docs": "Retrieves schema information for all IDS (Intermediate Data Schema) in the organization.\n\n**Performance Notice**: This endpoint may timeout with large datasets (500+ schemas). For better performance, use the targeted alternatives below.\n\n**Recommended Alternatives**:\n1. **List available IDS (if needed)**: `GET /v1/artifacts/ids`\n2. **Get specific components**:\n- Schema: `GET /v1/artifacts/ids/{namespace}/{slug}/{version}/files/schema`\n- Mapping: `GET /v1/artifacts/ids/{namespace}/{slug}/{version" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Search files via Elasticsearch Query Language", "type": "http" }, "http": { "method": "POST", "url": "https://api.tetrascience.com/v1/datalake/searchEql", "headers": [ { "name": "ts-auth-token", "value": "" }, { "name": "x-org-slug", "value": "" } ], "params": [ { "name": "index", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute advanced search queries using Elasticsearch Query Language to find files based on metadata, content, labels, and processing attributes. Use this for complex search operations that require precise filtering." }, { "info": { "name": "Search Files (GET) (Deprecated)", "type": "http" }, "http": { "method": "GET", "url": "https://api.tetrascience.com/v1/fileinfo/search", "params": [ { "name": "category", "value": "", "type": "query", "description": "File category. Values are RAW, IDS, and PROCESSED." }, { "name": "from", "value": "", "type": "query", "description": "Display files started from a specified number in the results array. By default, files are displayed from the start of the array (the number 0). This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with size." }, { "name": "fromDate", "value": "", "type": "query", "description": "Search for files created on or after a specific date." }, { "name": "excludeTags", "value": "", "type": "query", "description": "Lists the tags that should be excluded. Files that have the specified tags associated with them do not appear in search results." }, { "name": "ids", "value": "", "type": "query", "description": "Name, type, and version of the schema used to create the IDS file. Format is {namespace}/{idsType}:{idsVersion}." }, { "name": "integrationId", "value": "", "type": "query", "description": "UUID for the integration." }, { "name": "integrationType", "value": "", "type": "query", "description": "Integration type. Values are EGNYTE, BOX, DOTMATICS, HRB CELLARIO, DATAHUB, PIPELINE, RAW, and API." }, { "name": "metadata.[key]", "value": "", "type": "query", "description": "Searches for files that have specific metadata." }, { "name": "pipelineId", "value": "", "type": "query", "description": "UUID for the pipeline." }, { "name": "rawFileId", "value": "", "type": "query", "description": "UUID for the RAW file that this file was generated from." }, { "name": "size", "value": "", "type": "query", "description": "Indicates the number of results to return in the request. This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with from." }, { "name": "sort", "value": "", "type": "query", "description": "Indicates the sort order for the search results. Sort occurs on the date (createAt timestamp, which occurred when the file was created in the data lake. Options: desc, asc" }, { "name": "sourceId", "value": "", "type": "query", "description": "UUID for the source." }, { "name": "sourceType", "value": "", "type": "query", "description": "Type of source, which is typically the name of the instrument or other lab equipment used to generate the data or report." }, { "name": "traceId", "value": "", "type": "query", "description": "UUID generated when the RAW file is first uploaded to the data lake. All files derived from the RAW file, such as an IDS file, have the same traceId." }, { "name": "tags", "value": "", "type": "query", "description": "Lists tags that the user added to the file." }, { "name": "toDate", "value": "", "type": "query", "description": "Search for files created on or before a specific date." }, { "name": "workflowId (Added version TDP 3.1.0)", "value": "", "type": "query", "description": "ID for the pipeline workflow." } ] }, "docs": "🚧 IMPORTANT The Search Files (GET) endpoint is on a deprecation path and does not support searching for files by metadata. It's recommended that you use the [/searchEql endpoint]() instead. For more information, see [Search Files, Search Workflow, and Paginate through All Pipeline Details API Endpoints Deprecation]() instead. For more information, see [Search Files, Search Workflow, and Paginate through All Pipeline Details API Endpoints Deprecation](