Export machine logs data

POST 
/api/v1/machines/:machineIdOrAlias/logs/export

This API endpoint export logs data (e.g., download .logs file) for the machine identified by the provided machineId or machine alias.

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 export machine logs

search string
start int64

Timestamp in epoch nanoseconds

end int64

Timestamp in epoch nanoseconds

stream stringrequired

Responses

200

Success response

application/json

Schema

Schema

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

payload

object

Schema for file export response

filePath string

Example (from schema)

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

Export machine logs example

Export machine logs response example

{
  "success": true,
  "message": "Machine logs exported successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "filePath": "http://example.com"
  }
}

Loading...