Add or update machine telemetry

POST 
/api/v1/machines/:machineIdOrAlias/telemetry

This API endpoint add or update telemetry data for the machine identified by the provided machineId or machine alias. This includes enabling or disabling logs and metrics collection.

Request

Path Parameters

machineIdOrAlias stringrequired

The machineId - unique id of the machine, alias - machine alias

application/json

Body

required

The request body containing the required details to add or update machine telemetry

isMetricsEnabled boolean
isLogsEnabled boolean

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]
payload boolean

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": true
}

Add or update machine telemetry example

Add or update machine telemetry response example

{
  "success": true,
  "message": "Machine telemetry config updated successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": true
}

Loading...