Data Acquisition

Agent System Metric Upload

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.

post/v1/data-acquisition/agent/systemmetric

Request

  • Base URL
    https://api.tetrascience.com
  • URL
    https://api.tetrascience.com/v1/data-acquisition/agent/systemmetric
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Request body multipart/form-data

agentIdstring required

This is the sourceId for a user-defined integration. Need to copy from the TetraScience 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".

systemmetricstring binary required

The system metric file to upload.

Response

200

messagestring

Example response

{
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.