Give Feedback

pydo.apps.get_logs()

Generated on 8 May 2026 from pydo version v0.34.0

Copy page as Markdown View page as Markdown

Usage

client.apps.get_logs(
    app_id="4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
    deployment_id="3aa4d20e-5527-4c00-b496-601fbd22520a",
    component_name="component",
    follow=None,
    type="BUILD",
    pod_connection_timeout=None,
)

Returns JSONRaises HttpResponseError

Description

Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.

Parameters

app_id string required

The app ID

deployment_id string required

The deployment ID

component_name string required

An optional component name. If set, logs will be limited to this component only.

follow boolean optional

Whether the logs should follow live updates.

type string required

The type of logs to retrieve
- BUILD: Build-time logs
- DEPLOY: Deploy-time logs
- RUN: Live run-time logs
- RUN_RESTARTED: Logs of crashed/restarted instances during runtime
- AUTOSCALE_EVENT: Logs of an autoscaling event (requires event_id)

One of: UNSPECIFIED, BUILD, DEPLOY, RUN, RUN_RESTARTED, AUTOSCALE_EVENT

Default: UNSPECIFIED

pod_connection_timeout string optional

An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m.

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.apps.get_logs(app_id="4f6c71e2", deployment_id="3aa4d20e", component_name="component")

Response Example

Show Response Example

{
  "live_url": "https://logs-example/build.log",
  "url": "https://logs/build.log",
  "historic_logs": [
    "https://logs-example/archive/build.log"
  ]
}

More Information

See /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs in the API reference for additional detail on responses, headers, parameters, and more.