Sign in
DigitalOcean-public.v2-new_Apps

Retrieve Aggregate Deployment Logs

Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.

get/v2/apps/{app_id}/deployments/{deployment_id}/logs

Path parameters

app_idstring required

The app ID

deployment_idstring required

The deployment ID

Query parameters

followboolean

Whether the logs should follow live updates.

type'UNSPECIFIED' | 'BUILD' | 'DEPLOY' | 'RUN' | 'RUN_RESTARTED' 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
pod_connection_timeoutstring

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

Response

A JSON object with urls that point to archived logs

historic_urlsstring[]
live_urlstring

A URL of the real-time live logs. This URL may use either the https:// or wss:// protocols and will keep pushing live logs as they become available.

Example response

{
  "historic_urls": [
    "https://logs/build.log"
  ],
  "live_url": "ws://logs/build"
}

Changes

Changed in 4 of the 8 revisions of this API.14