Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.
Name | Type | Required | Description | Default Value |
---|---|---|---|---|
app_id |
string | True | The app ID | |
component_name |
string | True | An optional component name. If set, logs will be limited to this component only. | |
follow |
boolean | False | Whether the logs should follow live updates. | |
type |
string | True | 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 |
UNSPECIFIED |
pod_connection_timeout |
string | False | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m . |
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
get_resp = client.apps.get_logs_active_deployment(app_id="a6adf840", component_name="component")
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.