API ReferenceProduct Documentation
API Reference

Create command

post
https://api.tetrascience.com/v1/commands

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. The maximum create command request size is 10 MB.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Agent or Connector ID for which command should be created

string
required

Action label, such as TetraScience.Connector.sdc.CreateMeasurementOrder

string
required
Defaults to 2021-01-31T23:58:43.749Z

Command expiration time (ISO timestamp). Must be at least 60 seconds from the current time.

metadata
object

Metadata key-value pairs

payload
object
required

Request body for the command

string
enum

The delivery method for the command payload. When "embedded" is specified the command body is included in the SQS message payload. When "referenced" is specified the command body is stored in S3 and only a reference to the S3 object is included in the SQS message payload. In case no value is passed and payload is small enough to be transferred over SQS "embedded" is used, otherwise "referenced" is used.

Allowed:
Responses

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago