v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Data Acquisition

Agent Configuration

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.

post/v1/data-acquisition/agent/config

Request body

agentIdstring required

This is the sourceId for a user-defined integration. Need to copy from the TDP web UI, where the user-defined integration is created. For existing TetraScience Agent who can connect to TetraScience Cloud directly, provide the agentId to this field.

agentVersionstring required

The Agent version, such as "v1.0.0".

Response

200

orgSlugstring

integrationIdstring

agentIdstring

agentNamestring

regionstring

bucketstring

streamBucketstring

backupBucketstring

kmsKeystring

integrationTypestring

metadataobject

logGroupNamestring

rpcSourceQueueUrlstring

rpcPlatformQueueUrlstring

Example response

{
  "orgSlug": "mgtest",
  "integrationId": "844dc7e9-a4c4-429c-b364-b54bf531c078",
  "agentId": "0db83bc0-0921-414c-ad1c-05d47af3dd44",
  "agentName": "test agent",
  "region": "us-east-2",
  "bucket": "ts-platform-dev-datalake",
  "streamBucket": "ts-platform-dev-stream",
  "backupBucket": "ts-platform-dev-backup",
  "kmsKey": "alias/customer-key-development-mgtest",
  "integrationType": "user_defined",
  "logGroupName": "/agents/mgtest/0db83bc0-0921-414c-ad1c-05d47af3dd44",
  "rpcSourceQueueUrl": "https://sqs.us-east-2.amazonaws/706717599419/onprem-0db83bc0-0921-414c-ad1c-05d47af3dd44.fifo",
  "rpcPlatformQueueUrl": "https://sqs.us-east-2.amazonaws/706717599419/onprem-development-command-service-inbound"
}