Get TVC Deployment debug logs

Get a bounded window of application logs from a debug-mode TVC deployment. Returned lines are collected from every running replica and sorted by platform timestamp.

organizationId · string · required

Unique identifier for a given Organization.

deploymentId · string · required

Unique identifier for a given TVC Deployment. The deployment must be running in debug mode.

tailLines · number

Limit returned history to the last N lines per replica. If unset or zero, no tail-line limit is applied.

sinceSeconds · string

Return logs newer than this many seconds ago. If unset or zero, no since-time limit is applied. Useful for clients that poll to follow logs.

A successful response returns the following fields:

entries · array · required

Application log entries sorted by platform timestamp.

Show entries details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_tvc_deployment_debug_logs \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "deploymentId": "<string>",
    "tailLines": "<number>",
    "sinceSeconds": "<string>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getTvcDeploymentDebugLogs({
  organizationId: "<string> (Unique identifier for a given Organization.)",
  deploymentId: "<string> (Unique identifier for a given TVC Deployment. The deployment must be running in debug mode.)",
  tailLines: 0 // Limit returned history to the last N lines per replica. If unset or zero, no tail-line limit is applied.,
  sinceSeconds: "<string> (Return logs newer than this many seconds ago. If unset or zero, no since-time limit is applied. Useful for clients that poll to follow logs.)"
});

200

{
  "entries": [
    {
      "line": {
        "content": "<string>",
        "ts": {
          "seconds": "<string>",
          "nanos": "<string>"
        }
      },
      "replicaLabel": "<string>"
    }
  ]
}